Skip to main content

Financial Institutions

https://api-sandbox.letpay.io/financialInstitution

Financial Institution Details​

This endpoint retrieves the details of financial institutions in Brazil.

Response​

    {
      "type": "object",
      "properties": {
        "institutionName": {
          "type": "string",
          "description": "The name of the financial institution"
        },
        "location": {
          "type": "string",
          "description": "The location of the financial institution"
        },
        "assets": {
          "type": "number",
          "description": "The total assets of the financial institution"
        },
        "numEmployees": {
          "type": "integer",
          "description": "The number of employees in the financial institution"
        }
      }
    }
AUTHORIZATIONAPI Key
KeyX-Auth-Token
ValueMY_ACCESS_TOKEN

Example Request​

Example Request​

200 - Success
    curl --location 'https://api-sandbox.letpay.io/financialInstitution' \
    --header 'X-Auth-Token: MY_ACCESS_TOKEN'

Example Response​

Header
  Content-Type: application/json
Body
    {
      "financial_institutions": [
        {
          "code": "246",
          "name": "BCO ABC BRASIL S.A.",
          "full_name": "Banco ABC Brasil S.A."
        }
      ],
      "refresh_token": "MY_ACCESS_TOKEN"
    }