| Requires any of the roles: | Reseller, Merchant |
| GET | /reports/bins/{binNumbers} | Gets the data associated with one to 10 bin numbers. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BinNumbers | path | List<string> | Yes | The bin numbers to lookup. Must be six to 11 digit numbers. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Bin | form | long | No | The BIN/first 6 digits of the card |
| CardBrand | form | string | No | The card brand (VISA, MasterCard, American Express, etc |
| IssuingOrg | form | string | No | The organization/bank that issued the card |
| CardType | form | string | No | Typically debit or credit |
| CardCategory | form | string | No | The category indicating special types of card such as corporate, purchasing, and prepaid |
| IssuingCountry | form | string | No | The country where the card was issued |
| IssuingCountryCodeA2 | form | string | No | The A2 country code |
| IssuingCountryCodeA3 | form | string | No | The A3 country code |
| IssuingCountryNumber | form | int? | No | The issuing country number |
| IssuingPhone | form | string | No | Phone number, if available, of the issuing organization |
| IssuingWebsite | form | string | No | Web site, if available, of the issuing organization |
| PanLength | form | int? | No | The length of credit card number |
| IssuedEntity | form | string | No | Defines if the BIN is PERSONAL or COMMERCIAL |
| IsRegulated | form | bool | No | Indicates if the card is regulated |
| IsCommercial | form | bool | No | True if the IssuedEntity is equal to 'COMMERCIAL' |
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.
GET /reports/bins/{binNumbers} HTTP/1.1
Host: syntch.simpay.net
Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <BinData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO"> <Bin>0</Bin> <CardBrand>String</CardBrand> <CardCategory>String</CardCategory> <CardType>String</CardType> <IsCommercial>false</IsCommercial> <IsRegulated>false</IsRegulated> <IssuedEntity>String</IssuedEntity> <IssuingCountry>String</IssuingCountry> <IssuingCountryCodeA2>String</IssuingCountryCodeA2> <IssuingCountryCodeA3>String</IssuingCountryCodeA3> <IssuingCountryNumber>0</IssuingCountryNumber> <IssuingOrg>String</IssuingOrg> <IssuingPhone>String</IssuingPhone> <IssuingWebsite>String</IssuingWebsite> <PanLength>0</PanLength> </BinData>