BEbelvo
Payment Authorizations (Brazil)

List all Charges for a Payment Authorization

Changed on

List all Charges associated with a Payment Authorization

get/payments/br/payment-authorizations/{payment_authorization_id}/charges/

Request

Path parameters

payment_authorization_idstring uuid required
Example:a3b92311-1888-449f-acaa-49ae28d68fcd

The payment-authorization.id the Charges belong to.

Query parameters

pageinteger
Example:1

A page number within the paginated result set.

page_sizeinteger
Example:100

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).

statusstring
Example:SETTLED

Return results only for this value.

status__instring
Example:PENDING,SETTLED

Return results for listed status.

Headers

X-Belvo-API-Resource-Version'Payments-BR.V2'
Example:Payments-BR.V2

Header indicating which version of the Payment API you want to use. Currently this is only applicable for Bank Accounts, Customers, and Payment Authorizations in Brazil. In the case that you are using our Payment Authorizations product (including Smart Transfers authorizations and their Charges), then you must send through this header set to Payments-BR.V2.

Response

OK

countinteger

The total number of results in your Belvo account.

nextstring uri nullable

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).

previousstring uri nullable

The URL to the previous page of results. If there is no previous page, the value is null.

Example response

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908&page=2",
  "results": [
    {
      "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "created_at": "2022-02-09T08:45:50.406032Z",
      "status_updated_at": "2025-06-09T08:45:50.406032Z",
      "status": "PENDING",
      "payment_authorization": "9fc68b84-f2d6-4142-b2ad-9d2d1ad70432",
      "payment_method": "PIX_OF_SMART_TRANSFERS",
      "amount": "100.12",
      "date": "2025-06-09",
      "end_to_end_id": "1234567890abcdef",
      "statement_description": "Super Shoe Store - Brown Sneakers",
      "external_id": "4b8a81a0-e33c-45a6-8567-479efb105f73",
      "beneficiary": {
        "bank_account": {
          "id": "088bc38f-1430-40c5-a5d2-80bd67189d11",
          "holder": {
            "name": "Jane Smith",
            "identifier": "12345678901"
          },
          "details": {
            "institution": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
            "agency": "5678",
            "number": "987654321",
            "account_type": "SAVINGS",
            "code": "678901"
          }
        }
      },
      "payer": {
        "bank_account": {
          "holder": {
            "identifier": "12345678902"
          },
          "details": {
            "code": "123345",
            "account_type": "CHECKINGS",
            "agency": "1234",
            "number": "123456789"
          }
        }
      },
      "metadata": {
        "internal_reference_id": "GGq73487w2"
      },
      "next": "7d159b21-9f25-4365-9fa2-734d20797819",
      "previous": "7d159b21-9f25-4365-9fa2-734d20797818"
    }
  ]
}

Changes

  • acb784e42ca0Revision changes
    • info

      added the new optional header request parameter X-Belvo-API-Resource-Version

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 32caefea14a8Revision changes
    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status