Pagos BIN Data API

https://docs.pagos.ai/bin-data-APIs/
Admin
The Pagos BIN Data API is a very simple REST API that expects to receive—as input—a 6-10 digit...
Tokens:5,896
Snippets:45
Trust Score:8.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET https://parrot.sandbox.pagosapi.com/batch/files

Source: https://docs.pagos.ai/bin-data-APIs/batch-api-testing

Retrieves an array of download URLs for mock BIN files in the sandbox environment.

```APIDOC
## GET https://parrot.sandbox.pagosapi.com/batch/files

### Description
Retrieves an array of download URLs for mock BIN files, including both Basic and Enhanced files. These URLs are unique to each call and valid for a short period.

### Method
GET

### Endpoint
https://parrot.sandbox.pagosapi.com/batch/files

### Request Headers
- **Authorization** (string) - Required - Bearer <api_key>

### Response
#### Success Response (200)
- **type** (string) - The type of BIN file (e.g., enhanced).
- **name** (string) - The filename of the compressed BIN data.
- **url** (string) - The pre-signed URL to download the file.
- **changes** (object) - Summary of changes including bins_removed, bins_updated, bins_added, and last_update_date.

#### Response Example
[
  {
    "type": "enhanced",
    "name": "parrot-batch-enhanced-2025-07-02T13:11:42.9915907Z.gz",
    "url": "https://parrot.sandbox.pagosapi.com/batch/files/download?preSignedUrl=...",
    "changes": {
      "bins_removed": 0,
      "bins_updated": 0,
      "bins_added": 0,
      "last_update_date": "2025-06-24T00:00:29.4982520Z",
      "sources": []
    }
  }
]
```

--------------------------------

### GET /bins

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-overview

Retrieves detailed information about a specific card BIN/IIN.

```APIDOC
## GET /bins

### Description
Retrieves known details for a provided 6-10 digit BIN/IIN.

### Method
GET

### Endpoint
https://parrot.prod.pagosapi.com/bins

### Parameters
#### Query Parameters
- **bin** (string) - Required - The 6-10 digit BIN/IIN to look up.

### Request Example
curl --request GET \
  --url 'https://parrot.prod.pagosapi.com/bins?bin=55630400' \
  --header 'Authorization:Bearer <api_key>'

### Response
#### Success Response (200)
- **card** (object) - Contains details about the card including brand, type, bank, and country information.

#### Response Example
{
  "card": {
    "number": {
      "length": 16
    },
    "bin_min": "5563040000000000000",
    "bin_max": "5563049999999999999",
    "card_brand": "MASTERCARD",
    "type": "Credit",
    "prepaid": false,
    "product": {
      "product_id": "MCF",
      "product_name": "Mastercard Corporate Fleet Card"
    },
    "bank": {
      "name": "CITIBANK N.A."
    },
    "country": {
      "alpha2": "US",
      "numeric": "840",
      "name": "UNITED STATES OF AMERICA"
    },
    "correlation_id": "eyJGaWxlSWQiOjI3NiwiVmVyc2lvbiI6NX0="
  }
}
```

--------------------------------

### Batch File Response Structure

Source: https://docs.pagos.ai/bin-data-APIs/batch-api-testing

Example JSON response containing download URLs and metadata for available BIN files.

```json
[
  {
    "type": "enhanced",
    "name": "parrot-batch-enhanced-2025-07-02T13:11:42.9915907Z.gz",
    "url": "https://parrot.sandbox.pagosapi.com/batch/files/download?preSignedUrl=aHR0cHM6Ly9wYXJyb3QtdjMtc25hcHNob3RzLXNhbmRib3guczMuYW1hem9uYXdzLmNvbS9lbmhhbmNlZC8yNDM1LTIwMjUtMDctMDJUMTM6MTE6NDIuOTkxNTkwN1ouZ3o/QVdTQWNjZXNzS2V5SWQ9QVNJQTU0SkpBVjczWlFaTERBREkmRXhwaXJlcz0xNzU3NDcxNTE0JngtYW16LXNlY3VyaXR5LXRva2VuPUlRb0piM0pwWjJsdVgyVmpFSGNhQ1hWekxXVmhjM1F0TVNKSE1FVUNJUUN3U21rN2dNR1ozNHJndGJUYlolMkJ4Nzd1d1Z1dGtFMmIlMkZuRWwxeWxZcnNTd0lnR012ak53SkpxUkpvYkluc0N0QWgxJTJCWTMwUG4yZ1dZcEVFOEc1b3M3WGlJcW1nUUk0UCUyRiUyRiUyRiUyRiUyRiUyRiUyRiUyRiUyRiUyRkFSQUFHZ3c1TlRReE1EVTJNemc1TURNaURFQWpvODJGUUpkUkRGN1B0Q3J1QXg3MjR0SHJRR0tRT0FYVkdzVUtqQ2Ewc3FaZ2E3SEdQeXFQWnBwclJNJTJCUDIzdE0lMkJ0WlhDRVpGekJSS3RMUEkzeFBnaW1xdjlRd2JlRVk4OURwWXNPWnB0dnQlMkJhbVBiQ3ZGejRldW5DWiUyQmlvQlZmM2E3SXRVMFhkQ0ltd3NzUHFmbk05R1lZdmNaY2w0TEtkaDByWWJkN29hMmZTbThQWE50Um9UZUJoRWVoQzVVWnpoZ1NDaXNFemRTVnhEZWcxNzBuTzdtclQzTExsMUVLUnglMkJZdkxvRVU0YlU0bVFHcmRGZXRCcFJwaFUzaVZ4azlHSjljbkh2QSUyRnBxMmZLUTJWa2QwTURQZUhqZ0o0VTFBY2EzaHBDWXl2U0dpRDhuNkdEM1g4V3psT0R4RHpVN0pwU0M0S3RWR0RxZXozVWZXczVkWlRCaTNueVIwYXhPMWRjYUsyemZSMHFOMzdWZFM5VzE3Y2pJTk14dlZqeDFVdHRibmJUN3BwNVF5dWY5emRGQjdZazFPYnNuN3NicDhsWUxLUnlFS0gwVDBZZXNYVGQ0dUtvdkVPRmxZa1E0dyUyQjUlMkY1dHQyNiUyQnpxRnR0RlYxJTJCYUNLMW1qeTVZMjh4U0VUNlpsVG1COWVJJTJCRGdRUExjYWRQb01iZ21ESTJqRFZPY3JodEJGUmdXdGFza0g4amElMkJ5ZVZLN0ZUTkhoZTNjUUNRUUNvSmczaVlvTFJHNHdER2xYVG5tR3pQWG83aEI3NHJ5bTMyb2pFeVBoaGZmNWo1YmdGNFdpZkdHdU5MS3FtRjVJVEpIRjdDNiUyRnlHWVRjeURSQW1vWnM1cnd6dnBtYmslMkYlMkY3Z3NnaEFLQVJuUzJWUDJOYTJacDZmbG5NNWpNNlpoTUpYWmdzWUdPcVlCT0lGRllFYzlFTlhPaThuZ1lKWUx3TjdtTkdOMDFwTXlwNndmWFVqVjlhTDVWR2NkcXp2QVRrd3kwJTJGVFQwYnZ1OTNoSU5SUks5cVNSSE5qZWI2VVNDaXpDaHViS2YlMkZFUmdhOTZBY2ZNRHJVQTgwSUVONzNVQTNzU3RBRkFyMzdMOVpFZEVGZ3lOckxySDV0dTQyRTIzYTFab0RrVkpjTm9pZk4yelJ4bEtEaFJ1MW9ZdEtlYnpzdGpQckE5V0Z3U1RVSWtQT3FZMExRRjVmbkhEemJ2V1lIRlhlbmtFUSUzRCUzRCZTaWduYXR1cmU9UmllcjJXbyUyQmFTWFdYZHklMkZXQSUyRlNNTWNweWxVJTNE",
    "changes": {
      "bins_removed": 0,
      "bins_updated": 0,
      "bins_added": 0,
      "last_update_date": "2025-06-24T00:00:29.4982520Z",
      "sources": [
        {
          "bins_total": 6,
          "source": "MASTERCARD",
          "changes": {
            "percentage": "0.00",
            "removed": 0,
            "updated": 0,
            "added": 0
          }
        },
        {
          "bins_total": 6,
          "source": "VISA",
          "changes": {
            "percentage": "0.00",
            "removed": 0,
            "updated": 0,
            "added": 0
          }
        },
        {
          "bins_total": 6,
          "source": "DISCOVER",
          "changes": {
            "percentage": "0.00",
            "removed": 0,
            "updated": 0,
            "added": 0
          }
        },
        {
          "bins_total": 6,
          "source": "AMEX"
        }
      ]
    }
  }
]
```

--------------------------------

### BIN Lookup Response

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-testing

Example JSON response returned by the BIN Data API sandbox for a successful lookup.

```json
{
  "card": {
    "number": {
      "length": 16
    },
    "bin_length": 6,
    "pagos_bin_length": 6,
    "bin_min": "4854270000000000000",
    "bin_max": "4854279999999999999",
    "pan_or_token": "pan",
    "virtual_card": null,
    "level2": false,
    "level3": false,
    "alm": false,
    "account_updater": true,
    "domestic_only": false,
    "gambling_blocked": false,
    "issuer_currency": "USD",
    "reloadable": false,
    "additional_card_brands": [
      {
        "card_brand": "PULSE",
        "bin_max": "4854279999999999999",
        "bin_min": "4854270000000000000",
        "card_brand_product": null,
        "card_brand_bank_name": null,
        "ecom_enabled": true,
        "billpay_enabled": true
      }
    ],
    "card_brand": "VISA",
    "card_segment_type": "Business",
    "combo_card": null,
    "type": "Debit",
    "funding_source": "DEBIT",
    "prepaid": false,
    "product": {
      "product_id": "G",
      "product_name": "Visa Business"
    },
    "bank": {
      "name": "SPACE COAST CREDIT UNION",
      "phone": null,
      "url": null,
      "clean_name": "Space Coast Credit Union"
    },
    "country": {
      "alpha2": "US",
      "numeric": "840",
      "name": "UNITED STATES OF AMERICA"
    },
    "authentication": {
      "authentication_required": false,
      "authentication_name": null
    },
    "cost": {
      "interchange": {
        "regulated": false,
        "regulated_name": "GOVERNMENT EXEMPT INTERCHANGE FEE",
        "domestic": null,
        "inter": null,
        "intra": null,
        "notes": null
      }
    },
    "networkfees": {},
    "correlation_id": "eyJGaWxlSWQiOjIzMDc5LCJWZXJzaW9uIjoyNDAyfQ==",
    "issuer_supports_tokenization": null,
    "multi_account_access_indicator": "N",
    "shared_bin": false
  }
}
```

--------------------------------

### BIN Data API Response Structure

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-dictionary

Example of a successful BIN lookup response containing card details, issuer information, and network fees.

```json
{
  "card": {
    "number": {
      "length": 16
    },
    "bin_length": 6,
    "pagos_bin_length": 6,
    "bin_min": "5244780000000000000",
    "bin_max": "5244789999999999999",
    "pan_or_token": "pan",
    "virtual_card": null,
    "level2": false,
    "level3": false,
    "alm": null,
    "account_updater": null,
    "domestic_only": false,
    "gambling_blocked": null,
    "issuer_currency": null,
    "reloadable": false,
    "additional_card_brands": [
      {
        "card_brand": "NYCE",
        "bin_max": "4422669999999999999",
        "bin_min": "4422660000000000000",
        "card_brand_product": "NYCE Generic Product",
        "card_brand_bank_name": null,
        "ecom_enabled": true,
        "billpay_enabled": false
      }
    ],
    "card_brand": "MASTERCARD",
    "card_segment_type": "Consumer",
    "combo_card": null,
    "type": "Credit",
    "funding_source": "CREDIT",
    "prepaid": false,
    "product": {
      "product_id": "MCW",
      "product_name": "World Mastercard Card"
    },
    "bank": {
      "name": "Citadel Federal Credit Union",
      "phone": null,
      "url": null,
      "clean_name": "Citadel Federal Credit Union"
    },
    "country": {
      "alpha2": "US",
      "numeric": "840",
      "name": "UNITED STATES OF AMERICA"
    },
    "authentication": {
      "authentication_required": false,
      "authentication_name": null
    },
    "cost": {
      "interchange": {
        "regulated": false,
        "regulated_name": null,
        "domestic": null,
        "inter": null,
        "intra": null,
        "notes": null
      }
    },
    "networkfees": {},
    "correlation_id": "eyJGaWxlSWQiOjI0OTgxLCJWZXJzaW9uIjoxMjExfQ==",
    "issuer_supports_tokenization": true,
    "multi_account_access_indicator": null,
    "shared_bin": false,
    "flagged_for_delete_remaining_wks": null
  }
}
```

--------------------------------

### BIN Data API Response Format

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-overview

Example of the JSON object returned by the API containing card metadata, bank information, and country details.

```json
{
  "card": {
    "number": {
      "length": 16
    },
    "bin_min": "5563040000000000000",
    "bin_max": "5563049999999999999",
    "card_brand": "MASTERCARD",
    "type": "Credit",
    "prepaid": false,
    "product": {
      "product_id": "MCF",
      "product_name": "Mastercard Corporate Fleet Card"
    },
    "bank": {
      "name": "CITIBANK N.A."
    },
    "country": {
      "alpha2": "US",
      "numeric": "840",
      "name": "UNITED STATES OF AMERICA"
    },
    "correlation_id": "eyJGaWxlSWQiOjI3NiwiVmVyc2lvbiI6NX0="
  }
}
```

--------------------------------

### GET /bins

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-overview

Retrieves information for a single BIN. This endpoint is limited to 100 calls every 10 seconds.

```APIDOC
## GET /bins

### Description
Performs a lookup for a single BIN.

### Method
GET

### Endpoint
/bins
```

--------------------------------

### Look Up BIN Details via cURL

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-overview

Submit a GET request to the BIN Data API endpoint using a specific BIN and an authorization header.

```bash
curl --request GET \
  --url 'https://parrot.prod.pagosapi.com/bins?bin=55630400' \
  --header 'Authorization:Bearer <api_key>'
```

--------------------------------

### GET /bins/multiple

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-overview

Retrieves information for multiple BINs, supporting up to 50 BINs per call. This endpoint is limited to 6 calls every 10 seconds.

```APIDOC
## GET /bins/multiple

### Description
Performs a lookup for multiple BINs (up to 50 per call).

### Method
GET

### Endpoint
/bins/multiple
```

--------------------------------

### Retrieve Batch BIN Files

Source: https://docs.pagos.ai/bin-data-APIs/batch-api-testing

Use this cURL command to fetch download URLs for mock BIN files in the sandbox environment. Replace <api_key> with your generated Test Mode API key.

```bash
curl --request GET \
  --url 'https://parrot.sandbox.pagosapi.com/batch/files' \
  --header 'Authorization:Bearer <api_key>'
```

--------------------------------

### Lookup a BIN in Test Mode

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-testing

Use the sandbox endpoint to retrieve mock BIN details. Replace <api_key> with your generated test API key.

```bash
curl --request GET \
  --url 'https://parrot.sandbox.pagosapi.com/bins?enhanced=true&bin=485427' \
  --header 'Authorization:Bearer <api_key>'
```

--------------------------------

### Request Enhanced BIN Data via cURL

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-overview

Use the enhanced=true query parameter to retrieve up to 35 additional fields, including interchange costs and SCA requirements.

```bash
curl --request GET \
  --url 'https://parrot.prod.pagosapi.com/bins?bin=55630400&enhanced=true' \
  --header 'Authorization:Bearer <api_key>'
```
Tokens:
Raw