Sign in

v1

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

Get details about a payment intent

Get the details about a specific payment intent.

get/payments/br/payment-intents/{id}/

Path parameters

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

The payment-intent.id you want to get detailed information about.

Response

OK

idstring uuid required

Belvo's unique identifier for the current item.

customerstring uuid required

Belvo's unique ID for the customer related to this payment intent.

external_idstring uuid

An additional unique identifier for the resource for internal purposes.

{% admonition type="success" name="Highly Recommended" %} We recommend using this field to store your own unique identifier for each resource (customer, bank account, payment intent, or enrollment). This can be useful for tracking the resource in your system and for debugging purposes. {% /admonition %}

created_atstring date-time required

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

created_bystring uuid required

The unique ID for the user that created this item.

updated_atstring date-time nullable required

The ISO-8601 timestamp of when the payment intent was last updated.

status'REQUIRES_PAYMENT_METHOD' | 'REQUIRES_ACTION' | 'SUCCEEDED' | 'PROCESSING' | 'FAILED' required

The current status of the payment intent.

amountstring required

Amount to be paid by your customer.

currency'BRL' required

The currency of the amount paid, for example, BRL (Brazilian Real).

descriptionstring required

The description of the payment.

statement_descriptionstring

A description that will appear on the customer's bank statement (recommended).

Note: If you do not use the statement_description parameter, the description value will be used as the statement description.

selected_payment_method_type'open_finance' | 'open_finance_biometric_pix' required

Selected payment method type. For 🇧🇷 Brazil's OFPI, can be either:

  • open_finance: For regular payments.
  • open_finance_biometric_pix: For biometric payments using the PIX network.
allowed_payment_method_typesstring[] required

A list of payment method types allowed in this payment intent. For OFPI, the value will 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

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.

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.