Silverflow

Silverflow Bins API

GitHub OpenAPI

Operations 3

GET /bins List Bins #
GET /bins/{binKey} Get Bin #
GET /bins/{binKey}/configurations List Bin Configurations #

Documentation

📖
Documentation
https://docs.silverflow.com/
📖
APIReference
https://docs.silverflow.com/apidocs/latest/index.html
📖
GettingStarted
https://docs.silverflow.com/guides/getting-started
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/authentication/silverflow-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/rate-limits/silverflow-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/openapi/silverflow-bins-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/asyncapi/silverflow-events-webhooks.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/errors/silverflow-problem-types.yml
🔗
DeclineCodes
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/errors/silverflow-decline-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/conventions/silverflow-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/conventions/silverflow-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/data-model/silverflow-data-model.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/sandbox/silverflow-sandbox.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/mcp/silverflow-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/silverflow-bins-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

silverflow-bins-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: '**This OpenAPI specification cannot be used for code generation.** Please reach out to your TAM regarding code generation using the API Spec.'
  version: 1.417.0
  title: Silverflow Bins API
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
servers:
- url: https://eu-west-1.api.silverflow.com/v1
  description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
- url: https://us-east-2.api.silverflow.com/v1
  description: Production URL for North America
- url: https://eu-west-1.api-sbx.silverflow.com/v1
  description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
security:
- ApiKey: []
- BearerToken: []
tags:
- name: Bins
  description: ' '
paths:
  /bins:
    get:
      operationId: getBins
      summary: List Bins
      description: 'This operation can return all Agent Bins, one page at a time.


        Requires `agents:ListBins` permission.'
      tags:
      - Bins
      parameters:
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offsetToken'
      responses:
        '200':
          description: A (paged) list of Bins
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BinsPage'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /bins/{binKey}:
    get:
      operationId: getBin
      summary: Get Bin
      description: Requires `agents:GetBin` permission.
      tags:
      - Bins
      parameters:
      - $ref: '#/components/parameters/binKey'
      responses:
        '200':
          description: The referenced Bin
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bin'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
  /bins/{binKey}/configurations:
    get:
      operationId: getBinConfigurations
      summary: List Bin Configurations
      description: 'This operation can return all Bin Configurations, one page at a time.


        Requires `agents:GetBin` permission.'
      tags:
      - Bins
      parameters:
      - $ref: '#/components/parameters/binKey'
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offsetToken'
      - $ref: '#/components/parameters/validFrom'
      responses:
        '200':
          description: A (paged) list of Bin Configurations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BinConfigurationsPage'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
components:
  responses:
    UnauthorizedError:
      description: Authentication information is missing or invalid
      headers:
        WWW_Authenticate:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://datatracker.ietf.org/doc/html/rfc2616#section-10.4.2
            title: Unauthorized
            status: 401
            detail: The credentials supplied in the request are either missing, invalid, or not applicable in the current scope
    ForbiddenError:
      description: The authenticated client is forbidden to make the request for the resource identified.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://datatracker.ietf.org/doc/html/rfc2616#section-10.4.4
            title: Forbidden
            status: 403
            detail: The server is refusing to execute the request for the current authenticated user
            instance: https://api.silverflow.co/v1/merchants/mct-1hPdFqhgstYTUhlphPDp
    TooManyRequestsError:
      description: The number of requests (per minute) has exceeded the configured maximum
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: /silverflow/problems/too-many-requests
            title: Too Many Requests
            status: 429
            detail: You have exceeded the rate limit. Please try again after the specified delay.
            instance: /silverflow/b0451a9d-f66d-4ef7-9f5d-d48064a2bb3e
    BadRequestError:
      description: The request was malformed. See the response body for details
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestProblemDetail'
          example:
            type: /silverflow/problems/bad-request
            title: Bad Request
            status: 400
            detail: Validation errors occurred
            instance: https://api.silverflow.co/v1/merchants/mct-1hPdFqhgstYTUhlphPDp
            validationErrors:
            - instancePath: /tags/0/businessId
              message: must not be longer than 255 characters
    NotFoundError:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://datatracker.ietf.org/doc/html/rfc2616#section-10.4.5
            title: Not Found
            status: 404
            detail: The entity referenced in the request could not be found
            instance: https://api.silverflow.co/v1/merchants/mct-1hPdFqhgstYTUhlphPDp
  schemas:
    BadRequestProblemDetail:
      description: 'A ''problem detail'' object for Bad Request (400) errors. Extends the base ProblemDetail

        with a validationErrors array that provides detailed information about validation failures.

        '
      allOf:
      - $ref: '#/components/schemas/ProblemDetail'
      - type: object
        required:
        - type
        - title
        - status
        - detail
        - instance
        properties:
          type:
            type: string
            description: URI reference identifying the problem type.
            enum:
            - /silverflow/problems/bad-request
            example: /silverflow/problems/bad-request
          title:
            type: string
            description: A short summary of the problem type.
            enum:
            - Bad Request
          status:
            type: integer
            format: int32
            description: The HTTP status code (400 for Bad Request).
            enum:
            - 400
          detail:
            type: string
            description: A human readable explanation specific to this occurrence of the problem.
            example: Validation errors occurred
          instance:
            type: string
            description: An absolute URI that identifies the specific occurrence of the problem.
          validationErrors:
            type: array
            description: 'An array of validation errors that occurred during request processing. Each item can be either

              a simple string message or an object with detailed error information including the path and message.

              '
            items:
              oneOf:
              - type: string
                description: A simple validation error message
                example: Invalid 'mid' length
              - type: object
                description: A detailed validation error with path and message
                required:
                - instancePath
                - message
                properties:
                  instancePath:
                    type: string
                    description: The JSON path to the field that caused the validation error
                    example: /merchantAcceptor/mid
                  message:
                    type: string
                    description: The validation error message
                    example: must be at most 15 characters
        additionalProperties: false
    amexModel:
      type: string
      description: The AMEX business model. In the PayFac model, authorization is performed using the SE Number on the BIN. In the Direct Merchant or Payment Designation model, authorization is performed using the SE Number on the Acceptor. If `amexModel` is undefined, the AMEX Bin is treated as a PayFac Bin by default.
      default: payfac
      enum:
      - payfac
      - direct_merchant
      - payment_designation
    AmexBin:
      allOf:
      - type: object
        required:
        - network
        - messageSystem
        - acquirerIdCode
        - acquirerBin
        properties:
          network:
            type: string
            enum:
            - american-express
          messageSystem:
            type: string
            enum:
            - DMS
            description: Determines the message structure and Data Element definitions for card network.
          acquirerIdCode:
            allOf:
            - description: Acquirer Institution ID code (Submitter ID). For PayFac model, this identifies the Payment Facilitator.
            - $ref: '#/components/schemas/amexAcquirerIdCode'
          acquirerBin:
            allOf:
            - description: SE Number assigned by AMEX for the Payment Facilitator. For Direct Merchant, this field is automatically copied from acquirerIdCode field.
            - $ref: '#/components/schemas/amexAcquirerBin'
          authorizationCurrency:
            type: string
            $ref: '#/components/schemas/authorizationCurrency'
          amexModel:
            $ref: '#/components/schemas/amexModel'
      - $ref: '#/components/schemas/BaseBin'
    BinsPage:
      allOf:
      - $ref: '#/components/schemas/Page'
      - type: object
        required:
        - bins
        properties:
          bins:
            type: array
            items:
              $ref: '#/components/schemas/Bin'
      example:
        offsetToken: Q29uZ3JhdHVhbHRpb25zISBZb3Ugc3VjY2Vzc2Z1bGx5IGJhc2U2NC1kZWNvZGVkIHRoZSB2YWx1ZS4gWW91J3JlIG9uIGEgcm9sbCBzbyBrZWVwIGdvaW5nIQ==
        bins:
        - key: bin-1iXRhbDjrT2Yxvo0mSZN
          status: active
          description: Example Acquirer - Mastercard
          acquirerIdCode: 222222
          acquirerBin: 555555
          acquirerCountryCode:
            alpha3: DEU
            alpha2: DE
            numeric: '276'
          acquirerAgentKey: cgt-1nUP5yspouqwUHYSZo9V
          network: mastercard
          messageSystem: DMS
          shared: false
          created: '2020-08-24T14:15:22.014Z'
          lastModified: '2020-08-24T21:39:01.957Z'
          version: 2
        - key: bin-1mCKWvpBRrRpVqRw0bH9
          status: active
          description: Example Acquirer - Visa
          acquirerIdCode: 444444
          acquirerBin: 444444
          bid: 55555555
          acquirerCountryCode:
            alpha3: DEU
            alpha2: DE
            numeric: '276'
          network: visa
          messageSystem: DMS
          shared: false
          created: '2020-08-24T14:15:22.014Z'
          lastModified: '2020-08-24T21:39:01.957Z'
          version: 2
    settlementServices:
      description: A list of Settlement Services as provided by a card network.
      type: array
      items:
        $ref: '#/components/schemas/settlementService'
        minItems: 1
    version:
      type: integer
      description: The version of this object
      format: int64
    MastercardBin:
      allOf:
      - type: object
        required:
        - network
        - messageSystem
        - acquirerIdCode
        - acquirerBin
        properties:
          network:
            type: string
            enum:
            - mastercard
          messageSystem:
            $ref: '#/components/schemas/messageSystem'
          acquirerIdCode:
            type: string
            description: Acquirer Institution ID code. For Mastercard, this field corresponds to the Acquirer ICA.
            pattern: ^\d+$
            minLength: 6
            maxLength: 6
          acquirerBin:
            type: string
            description: Acquirer Bin. The Bin number as assigned by the card network. For Mastercard, this is also referred to as the Acquirer Reference ID.
            pattern: ^\d+$
            minLength: 6
            maxLength: 6
      - $ref: '#/components/schemas/BaseBin'
    ExtendedFreeTextField:
      type: string
      pattern: ^[\x20-\x7E\xA0-\xA3\xA5\xA7\xA9-\xB3\xB5-\xB7\xB9-\xBB\xBF-\xFF\u20AC\u0160\u0161\u017D\u017E\u0152\u0153\u0178]+$
      minLength: 1
      maxLength: 160
      description: Clients not enrolled in the "extended character set beta" are still subject to the `^[\w +=.,:;!?$@()-]+$` pattern for field input.
    discoverAcquirerIdCode:
      type: string
      description: Acquirer Institution ID code.
      pattern: ^\d+$
      minLength: 1
      maxLength: 11
    lastModified:
      type: string
      description: The date and time this object was last modified
      format: date-time
    moreItems:
      type: boolean
    created:
      type: string
      description: The date and time this object was created
      format: date-time
    Bin:
      discriminator:
        propertyName: network
        mapping:
          visa: '#/components/schemas/VisaBin'
          mastercard: '#/components/schemas/MastercardBin'
          bancontact: '#/components/schemas/BancontactBin'
          american-express: '#/components/schemas/AmexBin'
          discover: '#/components/schemas/DiscoverBin'
          diners: '#/components/schemas/DinersBin'
      oneOf:
      - $ref: '#/components/schemas/VisaBin'
      - $ref: '#/components/schemas/MastercardBin'
      - $ref: '#/components/schemas/BancontactBin'
      - $ref: '#/components/schemas/AmexBin'
      - $ref: '#/components/schemas/DiscoverBin'
      - $ref: '#/components/schemas/DinersBin'
    dxsCode:
      description: The dxsCode is provided to acquirers by Diners during onboarding. A unique dxsCode is provided for each IIC.
      type: string
      pattern: ^[a-zA-Z0-9]+$
      minLength: 3
      maxLength: 3
    binConfigurationKey:
      description: A key assigned by Silverflow to uniquely identify a Bin configuration.
      type: string
      pattern: ^bcf-[a-zA-Z0-9]+$
      minLength: 5
      maxLength: 120
    messageSystem:
      type: string
      description: Determines the message structure and Data Element definitions for card network.
      enum:
      - DMS
      - SMS
      default: DMS
    acquirerAgentKey:
      type: string
      description: Acquirer Agent Key shows the owner agent Key of the Bin.
      pattern: ^cgt-[a-zA-Z0-9]+|^$
      default: ''
    amexDirectMerchantAcquirerBin:
      allOf:
      - description: For Direct Merchant, this field is automatically copied from acquirerIdCode field.
      - $ref: '#/components/schemas/amexAcquirerIdCode'
    countryCodeNumeric:
      type: string
      pattern: ^[0-9]+$
      minLength: 3
      maxLength: 3
      description: 'The ISO code of the country.


        **European ISO Country Codes**


        <details>


        | Country | Alpha-2 code | Numeric |

        | ------- | ------------ | ------- |

        | Åland Islands | AX | 248 |

        | Andorra | AD | 020 |

        | Austria | AT | 040 |

        | Belgium | BE | 056 |

        | Cyprus | CY | 196 |

        | Estonia | EE | 233 |  |

        | Finland | FI | 246 |

        | France | FR | 250 |

        | French Guiana | GF | 254 |

        | French Southern Territories | TF | 260 |

        | Germany | DE | 280 |

        | Greece | GR | 300 |

        | Guadeloupe | GP | 312 |

        | Ireland | IE | 372 |

        | Italy | IT | 380 |

        | Kosovo, United Nations Mission in Kosovo (UNMIK) | QZ | 900 |

        | Latvia | LV | 428 |

        | Lithuania | LT | 440 |

        | Luxembourg | LU | 442 |

        | Malta | MT | 470 |

        | Martinique | MQ | 474 |

        | Mayotte | YT | 175 |

        | Monaco | MC | 492 |

        | Montenegro | ME | 499 |

        | Netherlands | NL | 528 |

        | Portugal | PT | 620 |

        | Reunion | RE | 638 |

        | Saint Barthélemy | BL | 652 |

        | Saint Martin (French Part) | MF | 663 |

        | San Marino | SM | 674 |

        | Slovakia | SK | 703 |

        | Slovenia | SI | 705 |

        | Spain | ES | 724 |

        | St. Pierre and Miquelon | PM | 666 |

        | Vatican City State (Holy See) | VA | 336 |


        </details>


        **US ISO Country Codes**


        <details>


        | Country | Alpha-2 code | Numeric |

        | ------- | ------------ | ------- |

        | American Samoa | AS | 016 |

        | Bonaire, St. Eusasius and Saba | BQ | 535 |

        | British Indian Ocean Territory | IO | 086 |

        | Ecuador | EC | 218 |

        | Guam | GU | 316 |

        | Marshall Islands | MH | 584 |

        | Micronesia, Federated States of | FM | 583 |

        | Northern Mariana Islands | MP | 580 |

        | Palau | PW | 585 |

        | Palestine, State of | PS | 275 |

        | Puerto Rico | PR | 630 |

        | Timor-Leste | TP | 626 |

        | Turks and Caicos Islands | TC | 796 |

        | U.S. Minor Outlying Islands | UM | 581 |

        | United States | US | 840 |

        | Virgin Islands, British | VG | 092 |

        | Virgin Islands, U.S. | VI | 850 |


        </details>


        **Other ISO Country Codes**


        <details>


        | Country | Alpha-2 code | Numeric |

        | ------- | ------------ | ------- |

        | Afghanistan | AF | 004 |

        | Albania | AL | 008 |

        | Algeria | DZ | 012 |

        | Angola | AO | 024 |

        | Anguilla | AI | 660 |

        | Antarctica | AQ | 010 |

        | Antigua and Barbuda | AG | 028 |

        | Argentina | AR | 032 |

        | Armenia | AM | 051 |

        | Aruba | AW | 533 |

        | Australia | AU | 036 |

        | Azerbaijan | AZ | 031 |

        | Bahamas | BS | 044 |

        | Bahrain | BH | 048 |

        | Bangladesh | BD | 050 |

        | Barbados | BB | 052 |

        | Belarus | BR | 112 |

        | Belize | BZ | 084 |

        | Benin | BJ | 204 |

        | Bermuda | BM | 060 |

        | Bhutan | BT | 064 |

        | Bolivia, Plurinational State of | BO | 068 |

        | Bosnia and Herzegovina | BA | 070 |

        | Botswana | BW | 072 |

        | Bouvet Island | BV | 074 |

        | Brazil | BR | 076 |

        | Brunei Darussalam | BN | 096 |

        | Bulgaria | BG | 100 |

        | Burkina Faso | BF | 854 |

        | Burundi | BI | 108 |

        | Cambodia | KH | 116 |

        | Cameroon | CM | 120 |

        | Canada | CA | 124 |

        | Cape Verde | CV | 132 |

        | Cayman Islands | KY | 136 |

        | Central African Republic | CF | 140 |

        | Chad | TD | 148 |

        | Chile | CL | 152 |

        | China | CN | 156 |

        | Christmas Island | CX | 162 |

        | Cocos (Keeling) Islands | CC | 166 |

        | Colombia | CO | 170 |

        | Comoros | KM | 174 |

        | Congo | CG | 178 |

        | Cook Islands | CK | 184 |

        | Costa Rica | CR | 188 |

        | Côte D''Ivoire | CI | 384 |

        | Croatia | HR | 191 |

        | Cuba | CU | 192 |

        | Curacao | CW | 531 |

        | Czech Republic | CZ | 203 |

        | Democratic Republic of the Congo | CD | 180 |

        | Denmark | DK | 208 |

        | Djibouti | DJ | 262 |

        | Dominica | DM | 212 |

        | Dominican Republic | DO | 214 |

        | Egypt | EG | 818 |

        | El Salvador | SV | 222 |

        | Equatorial Guinea | GQ | 226 |

        | Eritrea | ER | 232 |

        | Ethiopia | ET | 230 |

        | Falkland Islands (Malvinas) | FK | 238 |

        | Faroe Islands | FO | 234 |

        | Fiji | FJ | 242 |

        | French Polynesia | PF | 258 |

        | Gabon | GA | 266 |

        | Gambia | GM | 270 |

        | Georgia | GE | 268 |

        | Ghana | GH | 288 |

        | Gibraltar | GI | 292 |

        | Greenland | GL | 304 |

        | Grenada | GD | 308 |

        | Guatemala | GT | 320 |

        | Guernsey | GG | 831 |

        | Guinea | GN | 324 |

        | Guinea-Bissau | GW | 624 |

        | Guyana | GY | 328 |

        | Haiti | HT | 332 |

        | Heard and McDonald Islands | HM | 334 |

        | Honduras | HN | 340 |

        | Hong Kong | HK | 344 |

        | Hungary | HU | 348 |

        | Iceland | IS | 352 |

        | India | IN | 356 |

        | Indonesia | ID | 360 |

        | Iraq | IQ | 368 |

        | Isle of Man | IM | 833 |

        | Israel | IL | 376 |

        | Jamaica | JM | 388 |

        | Japan | JP | 392 |

        | Jersey | JE | 832 |

        | Jordan | JO | 400 |

        | Kazakhstan | KZ | 398 |

        | Kenya | KE | 404 |

        | Kiribati | KI | 296 |

        | Korea, Republic of | KR | 410 |

        | Kuwait | KW | 414 |

        | Kyrgyzstan | KG | 417 |

        | Lao People''s Democratic Republic | LA | 418 |

        | Lebanon | LB | 422 |

        | Lesotho | LS | 426 |

        | Liberia | LR | 430 |

        | Libyan Arab Jamahiriya | LY | 434 |

        | Liechtenstein | LI | 438 |

        | Macao | MO | 446 |

        | Macedonia | MK | 807 |

        | Madagascar | MG | 450 |

        | Malawi | MW | 454 |

        | Malaysia | MY | 458 |

        | Maldives | MV | 462 |

        | Mali | ML | 466 |

        | Mauritania | MR | 478 |

        | Mauritius | MU | 480 |

        | Mexico | MX | 484 |

        | Moldova, Republic of | MD | 498 |

        | Mongolia | MN | 496 |

        | Montserrat | MS | 500 |

        | Morocco | MA | 504 |

        | Mozambique | MZ | 508 |

        | Myanmar (effective 1 November 2012) | MM | 104 |

        | Namibia | NA | 516 |

        | Nauru | NR | 520 |

        | Nepal | NP | 524 |

        | Netherlands Antilles | AN | 530 |

        | New Caledonia | NC | 540 |

        | New Zealand | NZ | 554 |

        | Nicaragua | NI | 558 |

        | Niger | NE | 562 |

        | Nigeria | NG | 566 |

        | Niue | NU | 570 |

        | Norfolk Island | NF | 574 |

        | Norway | NO | 578 |

        | Oman | OM | 512 |

        | Pakistan | PK | 586 |

        | Panama | PA | 591 |

        | Papua New Guinea | PG | 598 |

        | Paraguay | PY | 600 |

        | Peru | PE | 604 |

        | Philippines | PH | 608 |

        | Pitcairn | PN | 612 |

        | Poland | PL | 616 |

        | Qatar | QA | 634 |

        | Republic of South Sudan | SS | 728 |

        | Romania | RO | 642 |

        | Russian Federation | RU | 643 |

        | Rwanda | RW | 646 |

        | Samoa | WS | 882 |

        | Sao Tome and Principe | ST | 678 |

        | Saudi Arabia | SA | 682 |

        | Senegal | SN | 686 |

        | Serbia | RS | 688 |

        | Seychelles | SC | 690 |

        | Sierra Leone | SL | 694 |

        | Singapore | SG | 702 |

        | Sint Maarten (Dutch Part) | SX | 534 |

        | Solomon Islands | SB | 090 |

        | Somalia | SO | 706 |

        | South Africa | ZA | 710 |

        | South Georgia and the South Sandwich Islands | GS | 239 |

        | Sri Lanka | LK | 144 |

        | Saint Helena, Ascension and Tristan Da Cunha | SH | 654 |

        | St. Kitts and Nevis | KN | 659 |

        | St. Lucia | LC | 662 |

        | St. Vincent and the Grenadines | VC | 670 |

        | Suriname | SR | 740 |

        | Svalbard and Jan Mayen | SJ | 744 |

        | Swaziland | SZ | 748 |

        | Sweden | SE | 752 |

        | Switzerland | CH | 756 |

        | Taiwan | TW | 158 |

        | Tajikistan | TJ | 762 |

        | Tanzania, United Republic of | TZ | 834 |

        | Thailand | TH | 764 |

        | Togo | TG | 768 |

        | Tokelau | TK | 772 |

        | Tonga | TO | 776 |

        | Trinidad and Tobago | TT | 780 |

        | Tunisia | TN | 788 |

        | Turkey | TR | 792 |

        | Turkmenistan | TM | 795 |

        | Tuvalu | TV | 798 |

        | Uganda | UG | 800 |

        | Ukraine | UA | 804 |

        | United Arab Emirates | AE | 784 |

        | United Kingdom | GB | 826 |

        | Uruguay | UY | 858 |

        | Uzbekistan | UZ | 860 |

        | Vanuatu | VU | 548 |

        | Venezuela, Bolivarian Republic of | VE | 862 |

        | Vietnam | VN | 704 |

        | Wallis and Futuna | WF | 876 |

        | Western Sahara | EH | 732 |

        | Yemen | YE | 886 |

        | Zambia | ZM | 894 |

        | Zimbabwe | ZW | 716 |


        </details>'
      externalDocs:
        description: Find more info here
        url: https://www.iso.org/iso-3166-country-codes.html
      example: '528'
    BancontactBin:
      allOf:
      - type: object
        required:
        - network
        - messageSystem
        - acquirerIdCode
        - acquirerBin
        properties:
          network:
            type: string
            enum:
            - bancontact
          messageSystem:
            $ref: '#/components/schemas/messageSystem'
          acquirerIdCode:
            type: string
            description: Acquirer Institution ID code.
            pattern: ^\d+$
            minLength: 6
            maxLength: 6
          acquirerBin:
            type: string
            description: Acquirer Bin. The Bin number as assigned by the card network.
            pattern: ^\d+$
            minLength: 6
            maxLength: 6
      - $ref: '#/components/schemas/BaseBin'
    status:
      type: string
      description: The status of the object
      enum:
      - active
      - archived
    CountryCode:
      type: object
      required:
      - alpha3
      - alpha2
      - numeric
      properties:
        alpha3:
          $ref: '#/components/schemas/countryCodeAlpha3'
        alpha2:
          $ref: '#/components/schemas/countryCodeAlpha2'
        numeric:
          $ref: '#/components/schemas/countryCodeNumeric'
    amexAcquirerIdCode:
      type: string
      description: Acquirer Institution ID code (Submitter ID). For PayFac model, this identifies the Payment Facilitator.
      pattern: ^[A-Z0-9]+$
      minLength: 6
      maxLength: 11
    amexPaymentDesignationAcquirerBin:
      allOf:
      - description: For Payment Designator, this field is automatically copied from acquirerIdCode field.
      - $ref: '#/components/schemas/amexAcquirerIdCode'
    amexAcquirerBin:
      anyOf:
      - $ref: '#/components/schemas/amexPayfacAcquirerBin'
      - $ref: '#/components/schemas/amexDirectMerchantAcquirerBin'
      - $ref: '#/components/schemas/amexPaymentDesignationAcquirerBin'
    settlementCurrencies:
      description: A list of Settlement Currencies.
      type: array
      items:
        $ref: '#/components/schemas/settlementCurrency'
        minItems: 1
    offsetToken:
      type: string
      pattern: ^[a-zA-Z0-9%]+$
      minLength: 1
      maxLength: 2048
    discoverAcquirerBin:
      type: string
      description: Acquirer Bin. The Bin number as assigned by the card network.
      pattern: ^\d+$
      minLength: 1
      maxLength: 11
    amexPayfacAcquirerBin:
      type: string
      description: SE Number assigned by AMEX for the Payment Facilitator.
      pattern: ^\d{10}$
    DinersBin:
      allOf:
      - required:
        - network
        - messageSystem
        - acquirerBin
        - acquirerIdCode
        - dxsCode
        properties:
          network:
            type: string
            enum:
            - diners
          messageSystem:
            type: string
            enum:
            - DMS
            description: Determines the message structure and Data Element definitions for card network.
          acquirerBin:
            allOf:
            - description: For Diners, this field is automatically copied from the acquirerIdCode (IIC number).
            - $ref: '#/components/schemas/dinersAcquirerIdCode'
          acquirerIdCode:
            $ref: '#/components/schemas/dinersAcquirerIdCode'
          dxsCode:
            $ref: '#/components/schemas/dxsCode'
      - $ref: '#/components/schemas/BaseBin'
    BinConfiguration:
      type: object
      required:
      - key
      - status
      - binKey
      - defaultSettlementCurrency
      - additionalSettlementCurrencies
      - settlementServices
      - validFrom
      - created
      - version
      description: 'A Bin is a Bank Identification Number

        '
      properties:
        key:
          $ref: '#/components/schemas/binConfigurationKey'
        status:
          $ref: '#/components/schemas/status'
        binKey:
          $ref: '#/components/schemas/binKey'
        defaultSettlementCurrency:
          $ref: '#/components/schemas/settlementCurrency'
        additionalSettlementCurrencies:
          $ref: '#/components/schemas/settlementCurrencies'
        settlementServices:
          $ref: '#/components/schemas/settlementServices'
        validFrom:
          type: string
          description: The date and time this configuration is valid from
          format: date-time
        created:
          $ref: '#/components/schemas/created'
        lastModified:
          $ref: '#/components/schemas/lastModified'
        version:
          $ref: '#/components/schemas/version'
      example:
        key: bcf-21yKByQsszQHq7MZ6pf0
        status: active
        binKey: bin-1ZgTNYjaNghq6YgC3E4p
        validFrom: '2022-01-26T13:50:12.640Z'
        created: '2022-01-26T13:50:12.640Z'
        lastModified: '2020-08-24T21:39:01.957Z'
        version: 1
    dinersAcquirerIdCode:
      type: string
      description: Acquirer Institution ID code. For Diners, this field corresponds to the IIC number.
      pattern: ^\d+$
      minLength: 6
      maxLength: 11
    Page:
      type: object
      properties:
        offsetToken:
          $ref: '#/components/schemas/offsetToken'
        moreItems:
          $ref: '#/components/schemas/moreItems'
    countryCodeAlpha2:
      type: string
      pattern: ^[A-Z]+$
      minLength: 2
      maxLength: 2
      description: 'The ISO code of the country.


        **European ISO Country Codes**


        <details>


        | Country | Alpha-2 code | Numeric |

        | ------- | ------------ | ------- |

        | Åland Islands | AX | 248 |

        | Andorra | AD | 020 |

        | Austria | AT | 040 |

        | Belgium | BE | 056 |

        | Cyprus | CY | 196 |

        | Estonia | EE | 233 |  |

        | Finland | FI | 246 |

        | France | FR | 250 |

        | French Guiana | GF | 254 |

        | French Southern Territories | TF | 260 |

        | Germany | DE | 280 |

        | Greece | GR | 300 |

        | Guadeloupe | GP | 312 |

        | Ireland | IE | 372 |

        | Italy | IT | 380 |

        | Kosovo, United Nations Mission in Kosovo (UNMIK) | QZ | 900 |

        | Latvia | LV | 428 |

        | Lithuania | LT | 440 |

        | Luxembourg | LU | 442 |

        | Malta | MT | 470 |

        | Martinique | MQ | 474 |

        | Mayotte | YT | 175 |

        | Monaco | MC | 492 |

        | Montenegro | ME | 499 |

        | Netherlands | NL | 528 |

        | Portugal | PT | 620 |

        | Reunion | RE | 638 |

        | Saint Barthélemy | BL | 652 |

        | Saint Martin (French Part) | MF | 663 |

        | San Marino | SM | 674 |

        | Slovakia | SK | 703 |

        | Slovenia | SI | 705 |

        | Spain | ES | 724 |

        | St. Pierre and Miquelon | PM | 666 |

        | Vatican City State (Holy See) | VA | 336 |


        </details>


        **US ISO Country Codes**


        <details>


        | Country | Alpha-2 code | Numeric |

        | ------- | ------------ | ------- |

        | American Samoa | AS | 016 |

        | Bonaire, St. Eusasius and Saba | BQ | 535 |

        | British Indian Ocean Territory | IO | 086 |

        | Ecuador | EC | 218 |

        | Guam | GU | 316 |

        | Marshall I

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/openapi/silverflow-bins-api-openapi.yml