Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Charges (Brazil)

Get details about a Charge

Get the details about a specific Charge.

get/payments/br/charges/{charge_id}/

Path parameters

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

The charge.id you want details about.

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, then you must send through this header set to Payments-BR.V2.

{% admonition type="warning" name="Coming Soon" %} This version is in Coming Soon. As such, minor changes or bugs may occur. If you encounter any issues, please contact your Belvo representative. {% /admonition %}

Response

OK

OR
OR

Example response

{
  "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"
  }
}