| POST | /api/v1/token/omni | Creates a Omni token based on a card swipe | This endpoint is for swipe capable omni token creation. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | body | int | No | Specifies which lane to use. |
| VaultId | body | string | No | The Vault ID with Omni. |
| InokeManualEntry | body | bool | No | Invokes manual card entry. |
| IsCscSupported | body | string | No | Invokes prompt for cardholder to enter card security code for manual keyed card entry. |
| Configuration | body | TokenRequestConfiguration | No | Any value included in this section will override the corresponding value set in the triPOS.config |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CardReadRetries | form | int? | No | Number of retries in case of bad card read. The default value is 1. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountNumber | form | string | No | The card account number. |
| BinValue | form | string | No | The card bin value. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest. |
| CardHolderName | form | string | No | The card holder name on the card. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest. If the card is keyed for a CreateOmniTokenRequest this value will be empty. |
| CardLogo | form | string | No | The card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other. |
| EntryMode | form | string | No | Description of how card was entered. This value is only provided for a CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.Allowable Values
|
| ExpirationMonth | form | string | No | The card's expiration month |
| ExpirationYear | form | string | No | The card's expiration year |
| MerchantId | form | string | No | The merchant ID used to process the transaction. |
| TokenProvider | form | string | No | The Token Provider. |
| TokenId | form | string | No | The Token ID. |
| TransactionDateTime | form | string | No | Transaction date/time in ISO8601 format |
| Processor | form | Processor | No | Response information from the processor. |
| IsOffline | form | bool | No | A boolean value indicating whether triPOS is disconnected from the host. |
| BinAttributes | form | Dictionary<string, bool> | No | Available binAttributes of card. more» |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProcessorLogs | form | List<string> | No | [DEPRECATED] Use logs. |
| ProcessorRawResponse | form | string | No | [DEPRECATED] Use rawResponse. |
| ProcessorReferenceNumber | form | string | No | [DEPRECATED] Use the same reference number passed in the request. |
| ProcessorRequestFailed | form | bool | No | [DEPRECATED] Use top level properties (e.g. hasErrors). |
| ProcessorRequestWasApproved | form | bool | No | [DEPRECATED] Use top level properties (e.g isApproved). |
| ProcessorResponseCode | form | ProcessorResponseCode | No | [DEPRECATED] Use expressResponseCode.Allowable Values
|
| ProcessorResponseMessage | form | string | No | [DEPRECATED] Use expressResponseMessage. |
| ExpressResponseCode | form | string | No | The response code received from Express. |
| ExpressResponseMessage | form | string | No | The response message received from Express. |
| HostResponseCode | form | string | No | The response code received from the host via Express. NOTE: This value is only populated if Express send the request to the host. |
| HostResponseMessage | form | string | No | The response message received from the host via Express. NOTE: This value is only populated if Express send the request to the host. |
| Logs | form | List<string> | No | A list of messages pertaining processing the transaction. |
| RawResponse | form | string | No | The raw processor response. In the case of Express, this is the raw XML returned by the Express platform. |
| RawRequest | form | string | No | |
| ProcessorName | form | ProcessorName | No |
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/CreateOmniTokenRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"laneId":0,"vaultId":"String","invokeManualEntry":false,"isCscSupported":"String","configuration":{"cardReadRetries":0}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"accountNumber":"String","binValue":"String","cardHolderName":"String","cardLogo":"String","entryMode":"String","expirationMonth":"String","expirationYear":"String","merchantId":"String","tokenProvider":"String","tokenId":"String","transactionDateTime":"String","_processor":{"processorLogs":["String"],"processorRawResponse":"String","processorReferenceNumber":"String","processorRequestFailed":false,"processorRequestWasApproved":false,"processorResponseCode":"Unknown","processorResponseMessage":"String","expressResponseCode":"String","expressResponseMessage":"String","hostResponseCode":"String","hostResponseMessage":"String","logs":["String"],"rawResponse":"String","rawRequest":"String","processorName":"Unknown"},"isOffline":false,"binAttributes":{"String":false},"_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"}]}