Ensure your integration with the BIN Data Batch API works correctly by making calls to our simulator in Test Mode.

Step 1: Create a Pagos Account or Sign In

If you’re interested in the BIN Data Batch API, you can try it out in Test Mode. Sign up for a Pagos account or log into your existing account, then click the environment toggle in the top-right corner; a yellow bar will appear across the top of the Pagos Service Panel to confirm you’re in Test Mode.

Step 2: Generate Your Test Mode API Key

In Test Mode, generate an API Key for the BIN Data Batch API.
These API Keys are universal across Test Mode and will be used for testing all Pagos API products. If you’ve already created an API key in Test Mode, you don’t need to create a new one.
To generate your API keys:
1

Click your settings icon in the top-right corner of your Pagos Service Panel.
2

Under Developers, click API Keys.
3

In the API Keys tab, click Create API Key to add a new key to your account.
4

In the side panel that opens, set your Key Name, then click Create API Key.
5

Copy your new API Key and store it somewhere secure.
This is the only time you can view this key!
6

Click I’ve Copied My Keys to confirm and exit the side panel.

Step 3: Test retreiving Batch BIN file using the BIN Data Batch API

Make a call to the BIN Data Batch API in Test Mode. Note that the endpoint for Test Mode points to sandbox.
curl --request GET \
  --url 'https://parrot.sandbox.pagosapi.com/batch/files' \
  --header 'Authorization:Bearer <api_key>'
This will return an array of download URLs for two mock BIN files: a Basic file containing only standard BIN data, and an Enhanced file containing both standard and enhanced BIN data. Follow the URLs to download the files.
These URLs are only valid for a short period of time and are unique to each call.
[
  {
    "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",
          "changes": {
            "percentage": "0.00",
            "removed": 0,
            "updated": 0,
            "added": 0
          }
        },
        {
          "bins_total": 6,
          "source": "CULIANCE",
          "changes": {
            "percentage": "0.00",
            "removed": 0,
            "updated": 0,
            "added": 0
          }
        },
        {
          "bins_total": 6,
          "source": "NYCE",
          "changes": {
            "percentage": "0.00",
            "removed": 0,
            "updated": 0,
            "added": 0
          }
        },
        {
          "bins_total": 6,
          "source": "PINLESS",
          "changes": {
            "percentage": "0.00",
            "removed": 0,
            "updated": 0,
            "added": 0
          }
        },
        {
          "bins_total": 6,
          "source": "PAGOS_DATA",
          "changes": {
            "percentage": "0.00",
            "removed": 0,
            "updated": 0,
            "added": 0
          }
        },
        {
          "bins_total": 6,
          "source": "EFTPOS_AUSTRALIA",
          "changes": {
            "percentage": "0.00",
            "removed": 0,
            "updated": 0,
            "added": 0
          }
        }
      ]
    }
  },
  {
    "type": "basic",
    "name": "parrot-batch-basic-2025-07-02T13:12:41.1270632Z.gz",
    "url": "https://parrot.sandbox.pagosapi.com/batch/files/download?preSignedUrl=aHR0cHM6Ly9wYXJyb3QtdjMtc25hcHNob3RzLXNhbmRib3guczMuYW1hem9uYXdzLmNvbS9iYXNpYy8yNDM1LTIwMjUtMDctMDJUMTM6MTI6NDEuMTI3MDYzMlouZ3o/QVdTQWNjZXNzS2V5SWQ9QVNJQTU0SkpBVjczWlFaTERBREkmRXhwaXJlcz0xNzU3NDcxNTE0JngtYW16LXNlY3VyaXR5LXRva2VuPUlRb0piM0pwWjJsdVgyVmpFSGNhQ1hWekxXVmhjM1F0TVNKSE1FVUNJUUN3U21rN2dNR1ozNHJndGJUYlolMkJ4Nzd1d1Z1dGtFMmIlMkZuRWwxeWxZcnNTd0lnR012ak53SkpxUkpvYkluc0N0QWgxJTJCWTMwUG4yZ1dZcEVFOEc1b3M3WGlJcW1nUUk0UCUyRiUyRiUyRiUyRiUyRiUyRiUyRiUyRiUyRiUyRkFSQUFHZ3c1TlRReE1EVTJNemc1TURNaURFQWpvODJGUUpkUkRGN1B0Q3J1QXg3MjR0SHJRR0tRT0FYVkdzVUtqQ2Ewc3FaZ2E3SEdQeXFQWnBwclJNJTJCUDIzdE0lMkJ0WlhDRVpGekJSS3RMUEkzeFBnaW1xdjlRd2JlRVk4OURwWXNPWnB0dnQlMkJhbVBiQ3ZGejRldW5DWiUyQmlvQlZmM2E3SXRVMFhkQ0ltd3NzUHFmbk05R1lZdmNaY2w0TEtkaDByWWJkN29hMmZTbThQWE50Um9UZUJoRWVoQzVVWnpoZ1NDaXNFemRTVnhEZWcxNzBuTzdtclQzTExsMUVLUnglMkJZdkxvRVU0YlU0bVFHcmRGZXRCcFJwaFUzaVZ4azlHSjljbkh2QSUyRnBxMmZLUTJWa2QwTURQZUhqZ0o0VTFBY2EzaHBDWXl2U0dpRDhuNkdEM1g4V3psT0R4RHpVN0pwU0M0S3RWR0RxZXozVWZXczVkWlRCaTNueVIwYXhPMWRjYUsyemZSMHFOMzdWZFM5VzE3Y2pJTk14dlZqeDFVdHRibmJUN3BwNVF5dWY5emRGQjdZazFPYnNuN3NicDhsWUxLUnlFS0gwVDBZZXNYVGQ0dUtvdkVPRmxZa1E0dyUyQjUlMkY1dHQyNiUyQnpxRnR0RlYxJTJCYUNLMW1qeTVZMjh4U0VUNlpsVG1COWVJJTJCRGdRUExjYWRQb01iZ21ESTJqRFZPY3JodEJGUmdXdGFza0g4amElMkJ5ZVZLN0ZUTkhoZTNjUUNRUUNvSmczaVlvTFJHNHdER2xYVG5tR3pQWG83aEI3NHJ5bTMyb2pFeVBoaGZmNWo1YmdGNFdpZkdHdU5MS3FtRjVJVEpIRjdDNiUyRnlHWVRjeURSQW1vWnM1cnd6dnBtYmslMkYlMkY3Z3NnaEFLQVJuUzJWUDJOYTJacDZmbG5NNWpNNlpoTUpYWmdzWUdPcVlCT0lGRllFYzlFTlhPaThuZ1lKWUx3TjdtTkdOMDFwTXlwNndmWFVqVjlhTDVWR2NkcXp2QVRrd3kwJTJGVFQwYnZ1OTNoSU5SUks5cVNSSE5qZWI2VVNDaXpDaHViS2YlMkZFUmdhOTZBY2ZNRHJVQTgwSUVONzNVQTNzU3RBRkFyMzdMOVpFZEVGZ3lOckxySDV0dTQyRTIzYTFab0RrVkpjTm9pZk4yelJ4bEtEaFJ1MW9ZdEtlYnpzdGpQckE5V0Z3U1RVSWtQT3FZMExRRjVmbkhEemJ2V1lIRlhlbmtFUSUzRCUzRCZTaWduYXR1cmU9UW9MRiUyQlhQbktMMXhub2E1cVYyVHB0ek9LdFklM0Q=",
    "changes": {
      "bins_removed": 0,
      "bins_updated": 0,
      "bins_added": 0,
      "last_update_date": "2025-06-24T00:00:29.4982520Z",
      "sources": null
    }
  }
]