Belvo Payment Transactions (Brazil) API

Each time you receive an inflow payment from your customer, a **transaction** is created in the Belvo database. You can use the Payment Transactions resource in order to get useful information about a transaction as well as the specific charge associated with it.

Operations 2

GET /payments/br/transactions/ List all payment transactions #
GET /payments/br/transactions/{id}/ Get details about a payment transaction #

Documentation

Specifications

Other Resources

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/belvo:belvo-payment-transactions-brazil-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.

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

OpenAPI Specification

belvo-payment-transactions-brazil-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Belvo API Docs Payment Transactions (Brazil) API
  version: 1.223.0
  description: '# Introduction


    Reach new audiences and convert more users by easily and safely connecting to their financial data, understanding their behavior and enabling instant payments with open finance. Through our API, you can access:


    ## Available Information and Payment Methods


    Belvo is an open banking API for Latin America that allows companies to access banking and fiscal information in a secure as well as agile way. Through our API, you can access:


    - Banking Information in Brazil

    - Employment Information in Brazil

    - Employment Information in Mexico

    - Fiscal Information in Mexico

    - Fiscal Information in Chile


    You can also use our API to make payments in:


    - Brazil

    - Mexico


    ## Data Dictionaries


    If you woud like the response documentation in Excel or CSV form, please download them from our public GitHub Reposiitory: Belvo Open Finance Data Dictionaries. Our EXCEL and CSV files are additionally localized into Spanish and Portuguese (Brazil). ## Environments


    We currently offer two environments: sandbox and production. ### Sandbox


    Available for:


    - 🟢 Aggregation and Enrichment

    - ⚪️ Payment Initiation


    Use our Sandbox environment to build your integration. We offer dummy data that mimics that of real-world use cases, which means you can test out all the endpoints, use the widget, and implement webhooks - just as you would with real-world data! All you need to get started with the Sandbox environment is to get your API keys. We really recommend that you start creating your integration in this environment. ### Production


    Available for:


    - 🟢 Aggregation and Enrichment

    - 🟢 Payment Initiation


    After you have tested your integration in the Sandbox environment and are ready to go live, you''ll need to request access to our Production environment. After you request access, our Sales Team will get in contact with you to schedule a meeting just to ensure your needs are met, and then you''ll just need to go through a certification process with one of our engineers to make sure that your integration is running optimally. To prepare for the certification meeting, just follow our Integration checklist. Once your integration is certified, all you''ll need to do is:


    - [ ] Request Production API keys (and change your Sandbox API keys in the code to these new ones). - [ ] Change the base URL that you make requests to from `sandbox.belvo.com` to `api.belvo.com`. - [ ] If you''re using webhooks, make sure to set a Production URL for your webhooks. ## Response codes


    We use the following HTTP status code in the response depending on the

    success or failure:


    | Status Code | Description |

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

    | `200` | ✅ **Success** - The content is available in the response body. |

    | `201` | ✅ **Success** - The content was created successfully on Belvo. |

    | `204` | ✅ **Success** - No content to return. |

    | `400` | ❌ **Bad Request Error** - Request returned an error, detail in the content.|

    | `401` | ❌ **Unauthorized** - The Belvo credentials provided are not valid.|

    | `404` | ❌ **Not Found** - The resource you try to access cannot be found.|

    | `405` | ❌ **Method Not Allowed** - The HTTP method you are using is not accepted for this resource.|

    | `408` | ❌ **Request Timeout** - The request timed out and was terminated by the server.|

    | `428` | ❌ **MFA Token Required** - MFA token was required by the institution to connect. |

    | `500` | ❌ **Internal Server Error** - The detail of the error is available in the response body.|


    ## Error handling


    Belvo API errors are returned in JSON format. For example, an error might look like this:


    ```json

    [

    {

    "request_id": "a6e1c493d7a29d91aed4338e6fcf077d",

    "message": "This field is required.",

    "code": "required",

    "field": "link"

    }

    ]

    ```


    Typically, an error response will have the following parameters:


    - `request_id`: a unique ID for the request, you should share it with the Belvo support team for investigations. - `message`: human-readable description of the error. - `code`: a unique code for the error.'
  contact:
    name: Need help?
    url: https://developers.belvo.com
    email: support@belvo.com
  x-logo:
    url: https://files.readme.io/5111448-belvo-for-developers.svg
    altText: Belvo Logo
servers:
- url: https://sandbox.belvo.com
  description: Sandbox
security:
- basicAuth: []
tags:
- name: Payment Transactions (Brazil)
  description: 'Each time you receive an inflow payment from your customer, a **transaction** is created in the Belvo database.


    You can use the Payment Transactions resource in order to get useful information about a transaction as well as the specific charge associated with it.'
paths:
  /payments/br/transactions/:
    get:
      tags:
      - Payment Transactions (Brazil)
      operationId: ListPaymentTransactionsBrazil
      summary: List all payment transactions
      description: List all payment transactions associated with your Belvo account.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/id__in'
      - $ref: '#/components/parameters/created_at'
      - $ref: '#/components/parameters/created_at__gt'
      - $ref: '#/components/parameters/created_at__gte'
      - $ref: '#/components/parameters/created_at__lt'
      - $ref: '#/components/parameters/created_at__lte'
      - $ref: '#/components/parameters/created_at__range'
      - $ref: '#/components/parameters/charge'
      - $ref: '#/components/parameters/charge__in'
      - $ref: '#/components/parameters/beneficiary'
      - $ref: '#/components/parameters/beneficiary__in'
      - $ref: '#/components/parameters/payer'
      - $ref: '#/components/parameters/payer__in'
      - $ref: '#/components/parameters/customer'
      - $ref: '#/components/parameters/customer__in'
      - $ref: '#/components/parameters/payment_intent'
      - $ref: '#/components/parameters/payment_intent__in'
      - $ref: '#/components/parameters/transaction__type'
      - $ref: '#/components/parameters/currency'
      - $ref: '#/components/parameters/description'
      - $ref: '#/components/parameters/amount'
      - $ref: '#/components/parameters/amount__gt'
      - $ref: '#/components/parameters/amount__gte'
      - $ref: '#/components/parameters/amount__lt'
      - $ref: '#/components/parameters/amount__lte'
      - $ref: '#/components/parameters/amount__range'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/common_pagination_properties'
                - properties:
                    results:
                      type: array
                      description: Array of transaction objects.
                      items:
                        $ref: '#/components/schemas/paymentTransaction'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
  /payments/br/transactions/{id}/:
    get:
      tags:
      - Payment Transactions (Brazil)
      operationId: DetailPaymentTransactionsBrazil
      summary: Get details about a payment transaction
      description: Get the details about a specific payment transaction.
      parameters:
      - name: id
        required: true
        in: path
        description: The `transaction.id` you want to get detailed information about.
        schema:
          type: string
          format: uuid
          example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paymentTransaction'
        '401':
          $ref: '#/components/responses/401_unauthorized_error'
        '403':
          $ref: '#/components/responses/403_access_denied_error'
        '404':
          $ref: '#/components/responses/404_not_found_error'
        '408':
          $ref: '#/components/responses/408_request_timeout_error'
        '500':
          $ref: '#/components/responses/500_unexpected_error'
components:
  parameters:
    amount__gte:
      name: amount__gte
      in: query
      description: Return results only for and more than this amount.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    payment_intent:
      name: payment_intent
      in: query
      description: The `payment-intent.id` you want to get results for.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    description:
      name: description
      in: query
      description: Return results for items with this description.
      schema:
        type: string
        example: Training shoes
    created_at__lt:
      name: created_at__lt
      in: query
      description: Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).
      schema:
        type: string
        format: date
        example: '2022-04-01'
    created_at__lte:
      name: created_at__lte
      in: query
      description: Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).
      schema:
        type: string
        format: date
        example: '2022-03-30'
    currency:
      name: currency
      in: query
      description: Return results that hold finances or balances in only this three-letter currency code.
      schema:
        type: string
        pattern: ^[A-Z]{3}$
        example: BRA
    customer:
      name: customer
      in: query
      description: The `customer.id` you want to get results for.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    charge:
      name: charge
      in: query
      description: The `charge.id` you want to get results for.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    page:
      name: page
      in: query
      description: A page number within the paginated result set.
      schema:
        type: integer
        format: int32
        minimum: 1
        example: 1
    beneficiary:
      name: beneficiary
      in: query
      description: The `beneficiary.id` you want to get results for.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    created_at:
      name: created_at
      in: query
      description: Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    amount__lt:
      name: amount__lt
      in: query
      description: Return results only for less than this amount.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    customer__in:
      name: customer__in
      in: query
      description: One or more `customer.id`s that you want to get results for.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: cb320adc-9a6b-4224-933a-5b08cf771ac7
    amount__lte:
      name: amount__lte
      in: query
      description: Return results only for this amount or less.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    payer__in:
      name: payer__in
      in: query
      description: One or more payer `bank-account.id`s that you want to get results for.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 901bc024-be57-4972-b4cf-31664b369d6e
    created_at__range:
      name: created_at__range
      in: query
      description: Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format). The first value indicates the start of the range and the second value indicates the end of the range.
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: string
          format: date
          example: '2022-03-03'
        example:
        - '2022-01-01'
        - '2022-12-31'
    amount__range:
      name: amount__range
      in: query
      description: Return results between this amount range. The first value indicates the start of the range and the second value indicates the end of the range.
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          example: 2000.02
        example:
        - 100
        - 5000
    page_size:
      name: page_size
      in: query
      description: 'Indicates how many results to return per page. By default we return 100 results per page.


        ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).

        '
      schema:
        type: integer
        format: int32
        default: 100
        minimum: 1
        maximum: 1000
        example: 100
    payer:
      name: payer
      in: query
      description: The payer's `bank-account.id` you want to get results for.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    charge__in:
      name: charge__in
      in: query
      description: One or more `charge.id`s that you want to get results for.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 2f122ae2-fc09-4c6d-9940-b6220e8d191d
    transaction__type:
      name: transaction__type
      in: query
      description: Return results for this transaction type. Can be either `INFLOW` or `OUTFLOW`.
      schema:
        type: string
        enum:
        - INFLOW
        - OUTFLOW
        example: INFLOW
    beneficiary__in:
      name: beneficiary__in
      in: query
      description: One or more `beneficiary.id`s that you want to get results for.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: ee43f030-4feb-4a06-95e7-d8d8afe5b16e
    id__in:
      name: id__in
      in: query
      description: Return information for these resource `id`s.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 6b3dea0f-be29-49d1-aabe-1a6d588642e6
    amount__gt:
      name: amount__gt
      in: query
      description: Return results only for more than this amount.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    created_at__gte:
      name: created_at__gte
      in: query
      description: Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).
      schema:
        type: string
        format: date
        example: '2022-05-04'
    created_at__gt:
      name: created_at__gt
      in: query
      description: Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    amount:
      name: amount
      in: query
      description: Return results only for this value.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    payment_intent__in:
      name: payment_intent__in
      in: query
      description: One or more `payment-intent.id`s that you want to get results for.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: cb320adc-9a6b-4224-933a-5b08cf771ac7
  schemas:
    RequestTimeoutError:
      type: object
      title: Request Timeout
      description: 'Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.

        '
      properties:
        code:
          type: string
          description: 'A unique error code (`request_timeout`) that allows you to classify and handle the error programmatically.



            ℹ️ Check our DevPortal for more information on how to handle <a href="https://developers.belvo.com/docs/belvo-api-errors#408-request_timeout" target="_blank">408 request_timeout errors</a>.

            '
          example: request_timeout
        message:
          type: string
          description: "A short description of the error. \n\n\nFor `request_timeout` errors, the description is:\n  \n  - `The request timed out, you can retry asking for less data by changing your query parameters`.\n"
          example: The request timed out, you can retry asking for less data by changing your query parameters
        request_id:
          $ref: '#/components/schemas/request_id'
    paymentTransaction:
      type: object
      required:
      - id
      - created_at
      - created_by
      - amount
      - currency
      - description
      - transaction_type
      - beneficiary
      - payer
      - charge
      properties:
        id:
          $ref: '#/components/schemas/id'
        created_at:
          $ref: '#/components/schemas/created_at'
        created_by:
          $ref: '#/components/schemas/created_by'
        amount:
          type: string
          description: 'The transaction amount.



            **Note**: The amount displayed is always positive as we indicate the direction of the transaction in `transaction_type` parameter.

            '
          example: '1020.00'
        currency:
          $ref: '#/components/schemas/EnumPaymentsCurrency'
        description:
          type: string
          maxLength: 128
          description: 'The description of the payment.

            '
          example: Training shoes
        transaction_type:
          $ref: '#/components/schemas/EnumPaymentTransactionType'
        beneficiary:
          type: string
          format: uuid
          description: 'Belvo''s unique ID used to identify the beneficiary''s bank account.

            '
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer:
          description: '**Note**: For OFPI, this will return an empty object `{}`.

            '
        payment_intent:
          type: string
          format: uuid
          description: The unique ID of the payment intent associated with the transaction.
          example: 004a28bb-fac2-4172-884b-5b6ea15314ad
        customer:
          type: string
          format: uuid
          description: Belvo's unique ID for the customer asscociated with this transaction.
          example: 9eebd63b-3339-44a9-8a5a-72bb6cb2f310
    request_id:
      type: string
      pattern: '[a-f0-9]{32}'
      description: 'A 32-character unique ID of the request (matching a regex pattern of: `[a-f0-9]{32}`). Provide this ID when contacting the Belvo support team to accelerate investigations.

        '
      example: 9e7b283c6efa449c9c028a16b5c249fb
    ConsentWithoutAccountsError:
      type: object
      title: Consent Without Accounts
      description: 'This error occurs when your user has removed accounts associated with the consent they provided. For example, when your user first generated their consent, they had a checking and a loan account at the institution but has closed those accounts since then.

        '
      properties:
        code:
          type: string
          description: 'A unique error code (`consent_without_accounts`) that allows you to classify and handle the error programmatically.



            ℹ️ Check our DevPortal for more information on how to handle <a href="https://developers.belvo.com/docs/belvo-api-errors#401-consent_without_accounts" target="_blank">401 consent_without_accounts errors</a>.

            '
          example: consent_without_accounts
        message:
          type: string
          description: "A short description of the error. \n\n\nFor `invalid` errors relating to `fetch_resources`, the description is:\n  \n  - `The institution only supports the following resources: (comma-separated list of supported resources)`.\n"
          example: 'The institution only supports the following resources: EMPLOYMENT_RECORDS, OWNERS'
        request_id:
          $ref: '#/components/schemas/request_id'
    EnumPaymentTransactionType:
      type: string
      enum:
      - INFLOW
      - OUTFLOW
      description: "The direction of the transaction.\n\n  - `INFLOW` indicates money coming into the account.\n  - `OUTFLOW` indicates money coming out of the account.\n"
      example: INFLOW
    created_by:
      type: string
      format: uuid
      description: The unique ID for the user that created this item.
      example: bcef7f35-67f2-4b19-b009-cb38795faf09
    UnauthorizedError:
      type: object
      title: Unauthorized Error
      description: 'This error occurs when you try to make an API call using incorrect Belvo API credentials (either your secret key or secret password, or both, are incorrect).

        '
      properties:
        code:
          type: string
          description: 'A unique error code (`authentication_failed`) that allows you to classify and handle the error programmatically.



            ℹ️ Check our DevPortal for more information on how to handle <a href="https://developers.belvo.com/docs/belvo-api-errors#401-authentication_failed" target="_blank">401 authentication_failed errors</a>.

            '
          example: authentication_failed
        message:
          type: string
          description: "A short description of the error. \n\n\nFor `authentication_failed` errors, the description is:\n\n  - `Invalid Secret Keys`.\n"
          example: Invalid Secret Keys
        request_id:
          $ref: '#/components/schemas/request_id'
    created_at:
      type: string
      format: date-time
      description: 'The ISO-8601 timestamp of when the data point was created in Belvo''s database.

        '
      example: '2022-02-09T08:45:50.406032Z'
    EnumPaymentsCurrency:
      type: string
      enum:
      - BRL
      description: 'The currency of the amount paid, for example, `BRL` (Brazilian Real).

        '
      example: BRL
    id:
      type: string
      format: uuid
      description: 'Belvo''s unique identifier for the current item.

        '
      example: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
    AccessToResourceDenied:
      type: object
      title: Access to Belvo API denied
      description: 'This error occurs when you try to access Belvo''s resource without the correct permissions.

        '
      properties:
        code:
          type: string
          description: 'A unique error code (`access_to_resource_denied`) that allows you to classify and handle the error programmatically.



            ℹ️ Check our DevPortal for more information on how to handle <a href="https://developers.belvo.com/docs/belvo-api-errors#403-access_to_resource_denied" target="_blank">403 access_to_resource_denied</a>.

            '
          example: access_to_resource_denied
        message:
          type: string
          description: "A short description of the error. \n\n\nFor `access_to_resource_denied` errors, the description is:\n  \n  - `You don't have access to this resource.`.\n"
          example: You don't have access to this resource.
        request_id:
          $ref: '#/components/schemas/request_id'
    UnexpectedError:
      type: object
      title: Unexpected Error
      description: 'This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.

        '
      properties:
        code:
          type: string
          description: 'A unique error code (`unexpected_error`) that allows you to classify and handle the error programmatically.



            ℹ️ Check our DevPortal for more information on how to handle <a href="https://developers.belvo.com/docs/belvo-api-errors#500-unexpected_error" target="_blank">500 unexpected_error errors</a>.

            '
          example: unexpected_error
        message:
          type: string
          description: "A short description of the error. \n\n\nFor `unexpected_error` errors, the description is:\n  \n  - `Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution`.\n"
          example: Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution
        request_id:
          $ref: '#/components/schemas/request_id'
    NotFoundError:
      type: object
      title: Not Found
      properties:
        code:
          type: string
          description: 'A unique error code (`not_found`) that allows you to classify and handle the error programmatically.

            '
          example: not_found
        message:
          type: string
          description: "A short description of the error.\n\n\nFor `not_found` errors, the description is:\n\n  - `Not found`\n"
          example: Not found
        request_id:
          $ref: '#/components/schemas/request_id'
    common_pagination_properties:
      type: object
      properties:
        count:
          type: integer
          format: int32
          description: The total number of results in your Belvo account.
          example: 130
        next:
          type:
          - string
          - 'null'
          format: uri
          description: 'The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is `null`.


            In our documentation example, we use `{endpoint}` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, `accounts` or `owners`).

            '
          example: https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908&page=2
        previous:
          type:
          - string
          - 'null'
          format: uri
          description: 'The URL to the previous page of results. If there is no previous page, the

            value is `null`.

            '
          example: null
  responses:
    408_request_timeout_error:
      description: Request Timeout
      content:
        application/json:
          schema:
            type: array
            title: Request Timeout
            description: "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.\n  \n"
            items:
              $ref: '#/components/schemas/RequestTimeoutError'
    403_access_denied_error:
      description: Access to Belvo API denied
      content:
        application/json:
          schema:
            type: array
            description: 'This error occurs when you try to access Belvo''s resource without the correct permissions.

              '
            items:
              $ref: '#/components/schemas/AccessToResourceDenied'
    404_not_found_error:
      description: Not Found Error
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/NotFoundError'
    500_unexpected_error:
      description: Unexpected Error
      content:
        application/json:
          schema:
            type: array
            title: Unexpected Error
            description: "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n  \n"
            items:
              $ref: '#/components/schemas/UnexpectedError'
    401_unauthorized_error:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: array
            items:
              anyOf:
              - $ref: '#/components/schemas/UnauthorizedError'
              - $ref: '#/components/schemas/ConsentWithoutAccountsError'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: "Belvo employs **basic authentication** using your secret keys (You can find your API secret keys in your Belvo Dashboard, under the **Developers** section).\n\n\nTo authenticate, you need to use your API `secretId` as the `username` and your API `secretPassword` as the `password`. These credentials need to be **Base64 encoded** and included in the `Authorization` header of your HTTP requests. For example:\n\n\n```shell\ncurl -X GET https://sandbox.belvo.com/api/ \\\n  -H \"Authorization: Basic $(echo -n 'YOUR_SECRET_ID:YOUR_SECRET_PASSWORD' | base64)\"\n```\n\nReplace `YOUR_SECRET_ID` and `YOUR_SECRET_PASSWORD` with your actual credentials. **Never expose your credentials in client-side code or public repositories**."
x-tagGroups:
- name: Core Resources
  tags:
  - Institutions
  - Links
  - Widget Access Token
  - Consents
- name: Open Finance Data Aggregation (Brazil)
  tags:
  - Owners
  - Accounts
  - Balances
  - Exchanges
  - Transactions
  - Bills
  - Investments Brazil
  - Investment Transactions Brazil
- name: Employments Brazil
  tags:
  - Employments Brazil
- name: Employment Records Mexico
  tags:
  - Employment Records Mexico
  - Current Employments Mexico
- name: Fiscal Mexico
  tags:
  - Invoices
  - Tax compliance status
  - Tax returns
  - Tax retentions
  - Tax status
  - Financial Statements
- name: Fiscal Chile
  tags:
  - Invoices Chile
  - Tax Status Chile
  - Debt Reports Chile
- name: Enrichment API
  tags:
  - Incomes
  - Recurring Expenses
  - Risk Insights
  - Employment Metrics
- name: Payment Initiation (Brazil)
  tags:
  - Payment Initiation introduction (Brazil)
  - Payment Institutions (Brazil)
  - Customers (Brazil)
  - Bank Accounts (Brazil)
  - Payment Authorizations (Brazil)
  - Charges (Brazil)
  - Payment Intents (Brazil)
  - Biometric payments Widget Access Token (Brazil)
  - Enrollments (Brazil)
  - Payment Transactions (Brazil)
x-provenance:
  method: harvested
  publisher: Belvo
  source: https://developers.belvo.com/_bundle/apis/BelvoOpenApiSpec.json?download
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)