v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Payment Intents (Brazil)

List all charges for a payment intent

List all charges associated with a payment intent.

get/payments/br/payment-intents/{payment_intent_id}/charges/

Path parameters

payment_intent_idstring uuid required

Example:a3b92311-1888-449f-acaa-49ae28d68fcd

The payment-intent.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:SUCCEEDED

Return results only for this value.

status__instring

Example:PENDING,SUCCEEDED

Return results for listed status.

Response

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-34d1044cb908page=2",
  "results": [
    {
      "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "created_at": "2022-02-09T08:45:50.406032Z",
      "updated_at": "2022-02-09T08:45:50.406032Z",
      "created_by": "bcef7f35-67f2-4b19-b009-cb38795faf09",
      "customer": "531aa631-70a0-4eeb-ab97-51dea3e90c89",
      "payment_intent": "50c04229-7b1d-4a53-951c-8ad53e10c6ca",
      "status": "PENDING",
      "amount": "100.12",
      "currency": "BRL",
      "description": "Training shoes",
      "statement_description": "Super Shoe Store - Brown Sneakers",
      "beneficiary": "58524ccc-89ac-4ab6-b62b-c3da3f19a722",
      "provider": "belvo",
      "payment_method_type": "open_finance",
      "payment_method_details": {
        "open_finance": {
          "schedule": {
            "single": {
              "date": "2024-10-22"
            }
          },
          "payer_institution": "db201c6a-e0ee-4caa-92d6-72b480d6d86f",
          "beneficiary_bank_account": "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc"
        }
      },
      "payment_method_information": {
        "open_finance": {
          "provider_request_id": "978c0c97ea847e78e8849634473c1f1",
          "redirect_url": "https://wakandanational.com/",
          "end_to_end_id": "F203262942022211117487a213b1d140",
          "settlement_date": "2024-10-22"
        }
      },
      "payer_information": {
        "bank_account": {
          "type": "CHECKINGS",
          "agency": "1234",
          "number": "123456789",
          "institution_id": "528228e2-d40d-4cec-948d-ec5edd7d081c"
        }
      },
      "transactions": [
        {
          "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
          "created_at": "2022-02-09T08:45:50.406032Z",
          "created_by": "bcef7f35-67f2-4b19-b009-cb38795faf09",
          "amount": "1020.00",
          "currency": "BRL",
          "description": "Training shoes",
          "transaction_type": "INFLOW",
          "beneficiary": "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc",
          "payment_intent": "004a28bb-fac2-4172-884b-5b6ea15314ad",
          "customer": "9eebd63b-3339-44a9-8a5a-72bb6cb2f310"
        }
      ],
      "metadata": {
        "internal_reference_id": "GGq73487w2"
      }
    }
  ]
}