| GET | /api/v1/signature/{laneId} | Displays the specified signature form | Use the signature endpoint to get a cardholder signature via the pinpad. See signature documentation for more information. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | path | int | Yes | The lane ID. |
| Header | query | string | No | The header text to display to the cardholder. |
| SubHeader | query | string | No | The subheader text to display to the cardholder. |
| Text | query | string | No | The text to display to the cardholder. |
| Form | query | string | Yes | The signature form to display. Options are 'simple' and 'contract'. more » |
| GotoIdle | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | form | int | No | The lane ID. |
| Signature | form | Signature | No | Signature data returned from the pinpad. |
| 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 |
|---|---|---|---|---|
| SignatureData | form | byte[] | No | The byte array of the signature in the format specified by Format. |
| SignatureFormat | form | string | No | The format of the signature.Allowable Values
|
| SignatureStatusCode | form | SignatureStatusCode | No | Indicates why a signature is or is not present.Allowable Values
|
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/GetLaneSignatureRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"laneId":0,"header":"String","subHeader":"String","text":"String","form":"String","gotoIdle":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"laneId":0,"signature":{"data":"AA==","format":"String","statusCode":"Unknown"},"_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"}]}