| POST | /api/v1/receipt | Prints a receipt on a PIN pad using the posted data. | This endpoint supports printing functionality. See Receipt documentation for more information. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | body | int | No | The lane ID. |
| AccountNumber | body | string | No | The card account number used in the transaction. |
| ApprovalNumber | body | string | No | Approval number of the transaction. |
| CardLogo | body | string | No | The card logo of the card used in the transaction. |
| CashbackAmount | body | decimal? | No | Cashback amount the customer received. |
| CopyType | body | ReceiptCopyType | No | Indicates whether the receipt is a Merchant Copy or a Customer Copy. |
| CurrencyCode | body | string | No | The currency code used in the transaction.Allowable Values
|
| CustomTemplate | body | string | No | A custom template that should be used instead of the default. |
| Emv | body | ReceiptEmvDto | No | The EMV information of the EMV card used in the transaction. |
| EntryMode | body | TransactionDataEntryMode? | No | Entry method used to enter card information, swipe, chip, etc. |
| Footer | body | List<string> | No | The list of individual lines of text to be displayed at the bottom of the receipt. |
| Header | body | List<string> | No | The list of individual lines of text to be displayed at the top of the receipt. |
| HostResponseCode | body | string | No | The code returned by the transaction's processing host. |
| IsApproved | body | bool? | No | Indicates whether the transaction was approved. |
| PinVerified | body | bool? | No | Indicates whether the entered PIN was verified. |
| ReceiptType | body | ReceiptType | No | The type of receipt. |
| ReferenceNumber | body | string | No | The transaction's reference number. |
| SubTotalAmount | body | decimal? | No | The subtotal amount of the transaction. |
| TerminalId | body | string | No | The ID of the terminal used in the transaction. |
| TipAmount | body | decimal? | No | The tip amount. |
| TotalAmount | body | decimal? | No | The total amount of the transaction. |
| TransactionDateTime | body | string | No | Date and time of the transaction. |
| TransactionId | body | string | No | The ID of the transaction. |
| SurchargeAmount | body | decimal? | No | The surcharge amount. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApplicationIdentifier | form | string | No | The Application Identifier also known as the AID. Identifies the application as described in ISO/IEC 7816-5. Printed receipts are required to contain the AID as hexadecimal characters. |
| ApplicationLabel | form | string | No | Mnemonic associated with the AID according to ISO/IEC 7816-5. If the Application Preferred Name is not available or the Issuer code table index is not supported, then the Application Label should be used on the receipt instead of the Application Preferred Name. |
| ApplicationPreferredName | form | string | No | Preferred mnemonic associated with the AID. When the Application Preferred Name is present and the Issuer code table index is supported, then this data element is mandatory on the receipt. |
| Cryptogram | form | string | No | The EMV cryptogram type and value. It is a preferred best practice to include this data element on the receipt, but is not mandatory. This field contains cryptogram type followed by the cryptogram value. |
| Tags | form | List<EmvTagKeyValue> | No | A name value collection of additional EMV tags that are required to appear on the receipt. |
| IssuerCodeTableIndex | form | string | No | Indicates the code table according to ISO/IEC 8859 for displaying the Application Preferred Name. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | form | int | No | The lane ID. |
| PrintResult | form | PrintResult | No | The result of the print operation is returned in the printResult field. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | form | List<ApiError> | No | A list of errors that occurred. |
| HasErrors | form | bool | No | Indicates if there are errors. |
| Links | form | IEnumerable<ApiLink> | No | A list of resource links |
| Logs | form | List<string> | No | A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose. |
| Type | form | string | No | The type of object held in the result. |
| Warnings | form | List<ApiWarning> | No | A list of warnings that occurred. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserMessage | form | string | No | An error message targeted at the end user of the integrated business application. |
| DeveloperMessage | form | string | No | An error message targeted at the developer of the integrated business application. |
| ErrorType | form | string | No | Code associated with the error if it exists. |
| ExceptionMessage | form | string | No | The body of the exception message. |
| ExceptionTypeFullName | form | string | No | The full name of the exception. |
| ExceptionTypeShortName | form | string | No | The short name of the exception. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Href | form | string | No | A target (a URI) |
| Method | form | string | No | The HTTP method to access the HREF target |
| Relation | form | string | No | The relation aka. 'rel' (the name of the link) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeveloperMessage | form | string | No | A warning message targeted at the developer of the integrated business application. |
| UserMessage | form | string | No | A warning message targeted at the end user of the integrated business application. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/ReceiptRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"laneId":0,"accountNumber":"String","approvalNumber":"String","cardLogo":"String","cashbackAmount":0,"copyType":"Merchant","currencyCode":"String","customTemplate":"String","emv":{"ApplicationIdentifier":"String","ApplicationLabel":"String","ApplicationPreferredName":"String","Cryptogram":"String","Tags":[{"Key":"String","Value":"String"}],"IssuerCodeTableIndex":"String"},"entryMode":"Unknown","footer":["String"],"header":["String"],"hostResponseCode":"String","isApproved":false,"pinVerified":false,"receiptType":"Sale","referenceNumber":"String","subTotalAmount":0,"terminalId":"String","tipAmount":0,"totalAmount":0,"transactionDateTime":"String","transactionId":"String","surchargeAmount":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"laneId":0,"printResult":"PrintSuccess","_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}