Sign in

e82dca4a4b97

latestOpenAPI 3.0.22026-08-101464031.4 MB
Payment Intents (Brazil)

Get details about a charge for a payment intent

Get the details about a specific charge associated with a payment intent.

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

Path parameters

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

The payment-intent.id the charge belongs to.

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

The charge.id you want details about.

Response

OK

idstring uuid required

Belvo's unique identifier for the current item.

created_atstring date-time required

The ISO-8601 timestamp of when the data point was created in Belvo's database.

updated_atstring date-time nullable required

The ISO-8601 timestamp of when the status of the charge was last updated.

created_bystring uuid

The unique ID for the user that created this item.

customerstring uuid

Belvo's unique ID for the customer that the charge was created for.

payment_intentstring uuid

The payment_intent.id associated with this charge.

status'CANCELED' | 'PENDING' | 'SCHEDULED' | 'SUCCEEDED' | 'FAILED' | 'PARTIAL' required

The current status of the charge. Can be one of the following values:

  • CANCELED
  • PENDING
  • SCHEDULED
  • SUCCEEDED
  • FAILED
  • PARTIAL
amountstring nullable required

The amount of the charge.

currency'BRL'

The currency of the amount paid. For 🇧🇷 Brazil, the value must be BRL (Brazilian Real).

descriptionstring

The description of the payment.

statement_descriptionstring

The description that will appear on the customer's bank statement (if provided).

beneficiarystring uuid required

Belvo's unique ID used to identify the beneficiary’s bank account.

provider'belvo' required

Note: This field has been deprecated and will be removed from the API in the future.

The provider used for the payment link.

payment_method_type'open_finance'

Selected payment method type. For 🇧🇷 Brazil's OFPI, the value must be open_finance.

failure_codestring nullable required

Error code that explains the reason behind a payment being unsuccessful (if applicable).

failure_messagestring nullable required

Further information regarding the failure_code.

metadataobject required

Optional and customizable object where you can provide any additional key-value pairs for your internal purposes. For example, an internal reference number.

⚠️ Note: You can only provide up to 50 keys (keys can have up to 50 characters each and each value can be up to 500 characters). We do not support nested objects, only ASCII values.

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