In previous sections such as Bank Details, Pix Deposit, and Pix Withdraw, one field stands out due to its importance for transactions involving bank details: the ISPB. The ISPB (Identificador de Sistema de Pagamentos Brasileiro) is a unique identifier assigned by the Central Bank of Brazil to institutions such as banks, credit unions, fintechs, and other financial or payment institutions registered in the Brazilian Payment System (SPB).

List Banks

This endpoint is designed to list the banks available in our system, enabling integrators to identify which bank corresponds to a specific ISPB. It offers three search options below.

Request Endpoint

To list all bank details, simply send a GET request to the following endpoint:

GET /partners-int/banks

Pagination

Each page returns up to 250 items. To navigate between pages, use the lastKey parameter.

GET /partners-int/banks?lastKey=12345678

Responses

Below are examples of the responses you might receive:

{
  "statusCode": "Done",
  "data": {
    "items": [
      {
        "ispb": "00000000",
        "code": "001",
        "name": "Banco do Brasil S.A.",
        "shortName": "BCO DO BRASIL S.A.",
        "updatedAt": "2024-12-22T22:37:03.197Z"
      },
      {
        "ispb": "00000208",
        "code": "070",
        "name": "BRB - BANCO DE BRASILIA S.A.",
        "shortName": "BRB - BCO DE BRASILIA S.A.",
        "updatedAt": "2024-12-22T22:37:03.439Z"
      },
      {
        "ispb": "00038121",
        "code": "n/a",
        "name": "Banco Central do Brasil - Selic",
        "shortName": "Selic",
        "updatedAt": "2024-12-22T22:37:03.679Z"
      }
    ],
    "lastKey": null
  }
}

{
    "statusCode": "Error",
    "error": {
        "name": "AuthenticationError",
        "message": "The authorization token is invalid",
        "details": {
            "reason": "AuthenticationTokenInvalid"
        }
    }
}

{
  "statusCode": "<string>",
  "error": {
    "name": "<string>",
    "message": "<string>"
  }
}

View Bank

This endpoint offers a more direct approach, focusing on finding an exact match of banking details based on the ISPB code.

Request Endpoint

Similar to the previous endpoint, this one also uses a GET request, with a slight difference in the endpoint path, as shown below:

GET /partners-int/banks/:ispb

Responses

When sending a request, you may receive the following responses:

{
    "statusCode": "Done",
    "data": {
        "ispb": "00000000",
        "code": "001",
        "name": "Banco do Brasil S.A.",
        "shortName": "BCO DO BRASIL S.A.",
        "updatedAt": "2024-11-06T18:19:51.426Z"
    }
}

{
    "statusCode": "Error",
    "error": {
        "name": "AuthenticationError",
        "message": "The authorization token is invalid",
        "details": {
            "reason": "AuthenticationTokenInvalid"
        }
    }
}

{
    "statusCode": "Error",
    "error": {
        "name": "EntityNotFound",
        "code": "EntityNotFound"
    }
}

{
  "statusCode": "<string>",
  "error": {
    "name": "<string>",
    "message": "<string>"
  }
}