| GET | /api/v1/binQuery/{laneId} | Determine if a card falls into a specific BIN range such as prepaid, healthcare, or debit. | Use the GET /binQuery/{laneId} endpoint to determine if a card falls into a specific BIN range such as prepaid, healthcare, or debit. The BIN query endpoint always makes an online call to the host in order to ensure the most up-to-date BIN information. If the card swiped or inserted is not found in the online BIN table, this endpoint returns a 404 Not Found HTTP response. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | path | int | Yes | The lane ID. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Check | body | bool | No | Check card indicator |
| Commercial | body | bool | No | Commercial card indicator |
| Credit | body | bool | No | Credit card indicator |
| Debit | body | bool | No | Debit card indicator |
| Ebt | body | bool | No | EBT card indicator |
| Fleet | body | bool | No | Fleet card indicator |
| Gift | body | bool | No | Gift card indicator |
| HsaFsa | body | bool | No | HSA/FSA card indicator |
| InternationalBin | body | bool | No | International BIN indicator |
| PinLessBillPay | body | bool | No | PINless Bill Pay indicator |
| Prepaid | body | bool | No | Prepaid card indicator |
| Wic | body | bool | No | WIC card indicator |
| DurbinBinRegulation | body | string | No | Durbin BIN Regulation indicatorAllowable Values
|
| 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. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/BinQueryRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/xml
Content-Length: length
<binQueryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
<laneId>0</laneId>
</binQueryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<binQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
<_errors>
<error>
<developerMessage>String</developerMessage>
<errorType>String</errorType>
<exceptionMessage>String</exceptionMessage>
<exceptionTypeFullName>String</exceptionTypeFullName>
<exceptionTypeShortName>String</exceptionTypeShortName>
<userMessage>String</userMessage>
</error>
</_errors>
<_hasErrors>true</_hasErrors>
<_links />
<_logs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</_logs>
<_type>String</_type>
<_warnings>
<warning>
<developerMessage>String</developerMessage>
<userMessage>String</userMessage>
</warning>
</_warnings>
<check>false</check>
<commercial>false</commercial>
<credit>false</credit>
<debit>false</debit>
<durbinBinRegulation>String</durbinBinRegulation>
<ebt>false</ebt>
<fleet>false</fleet>
<gift>false</gift>
<hsaFsa>false</hsaFsa>
<internationalBin>false</internationalBin>
<pinlessBillPay>false</pinlessBillPay>
<prepaid>false</prepaid>
<wic>false</wic>
</binQueryResponse>