GET | /api/v1/pinpad/card | Return a list of the triPOS Card endpoints |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardType | body | CardType | No | Indidcates whether the card read was a financial or non-financial card. |
FinancialCard | body | FinancialCard | No | Fields for a financial card response. These fields are populated if the card read was a financial card. |
NonFinancialCard | body | NonFinancialCard | No | Fields for a non-financial card response. These fields are populated if the card read was a non-financial card. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Errors | body | List<ApiError> | No | A list of errors that occurred. |
HasErrors | body | bool | No | Indicates if there are errors. |
Links | body | IEnumerable<ApiLink> | No | A list of resource links |
Logs | body | 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 | body | string | No | The type of object held in the result. |
Warnings | body | List<ApiWarning> | No | A list of warnings that occurred. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountNumber | body | string | No | The card account number. |
BinValue | body | string | No | The BIN entry that matched the account number. |
ExpirationYear | body | string | No | The card's expiration year |
ExpirationMonth | body | string | No | The card's expiration month |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Track1 | body | string | No | Track 1 of the non-financial card |
Track2 | body | string | No | Track 2 of the non-financial card |
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/CardDiscoveryRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"cardType":"Unknown","financialCard":{"accountNumber":"String","binValue":"String","expirationYear":"String","expirationMonth":"String"},"nonFinancialCard":{"track1":"String","track2":"String"},"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[{"href":"/api/v1/pinpad/card","method":"GET","rel":"card"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}