--- title: "Get details about a charge for a payment intent" method: GET path: "/payments/br/payment-intents/{payment_intent_id}/charges/{charge_id}/" tags: ["Payment Intents (Brazil)"] --- # Get details about a charge for a payment intent `GET /payments/br/payment-intents/{payment_intent_id}/charges/{charge_id}/` Get the details about a specific charge associated with a payment intent. ## Path parameters - `payment_intent_id` string, uuid, required - `charge_id` string, uuid, required ## Response `200` OK - ChargeBrazil - `id` string, uuid, required — Belvo's unique identifier for the current item. - `created_at` string, date-time, required — The ISO-8601 timestamp of when the data point was created in Belvo's database. - `updated_at` string, date-time, nullable, required — The ISO-8601 timestamp of when the status of the charge was last updated. - `created_by` string, uuid — The unique ID for the user that created this item. - `customer` string, uuid — Belvo's unique ID for the customer that the charge was created for. - `payment_intent` string, 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` - `amount` string, nullable, required — The amount of the charge. - `currency` 'BRL' — The currency of the amount paid. For 🇧🇷 Brazil, the value must be `BRL` (Brazilian Real). - `description` string — The description of the payment. - `statement_description` string — The description that will appear on the customer's bank statement (if provided). - `beneficiary` string, 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`. - `payment_method_details` ChargePaymentMethodDetailsOfpi, required — Details about the payment method. - `open_finance` ChargePaymentMethodDetailsOfpiContent — Information about the payer of a OFPI payment. - `schedule` union — Details regarding the scheduled payment (optional). For more information on how to schedule payments, please see our dedicated OFPI Scheduled Payments guide. - object, nullable — Details regarding the scheduled (one-off) payment. - `single` object, nullable — Details regarding the scheduled (one-off) payment. - `date` string, date — The date the one-off scheduled payment should be made, in `YYYY-MM-DD` format. - object — Details regarding the daily recurring payment. - `daily` object — Details regarding the daily recurring payment. - `start_date` string, date — The date the recurring daily payment should start on, in `YYYY-MM-DD` format. >**Note**: The `start_date` must be at least 1 day in the future. - `occurrences` integer — The number of times the payment should repeat. >**Note**: You must schedule at least `2` occurrences and no more than `60`. - object — Details regarding the weekly recurring payment. - `weekly` object — Details regarding the weekly recurring payment. - `start_date` string, date — The date the recurring weekly payment should start on, in `YYYY-MM-DD` format. >**Note**: The `start_date` must correspond to the first `day_of_week` specified and be at least 1 day in the future. - `day_of_week` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' — The day of the week the payment should be made. Can be one of the following values: - `MONDAY` - `TUESDAY` - `WEDNESDAY` - `THURSDAY` - `FRIDAY` - `SATURDAY` - `SUNDAY` - `occurrences` integer — The number of times the payment should repeat. >**Note**: You must schedule at least `2` occurrences and no more than `60`. - object — Details regarding the monthly recurring payment. - `monthly` object — Details regarding the monthly recurring payment. - `start_date` string, date — The date the recurring monthly payment should start on, in `YYYY-MM-DD` format. >**Note**: The `start_date` must correspond to the first `day_of_month` specified and be at least 1 day in the future. - `day_of_month` integer — The day of the month the payment should be made. Can be any integer between `1` and `31`. - `occurrences` integer — The number of times the payment should repeat. >**Note**: You must schedule at least `2` occurrences and no more than `24`. - object — Details regarding the custom recurring payment. - `custom` object — Details regarding the custom recurring payment. - `dates` string[] — The unique dates the recurring payment should be made, in `YYYY-MM-DD` format. >**Note**: The dates must be at least 1 day in the future and no more than 720 days in the future. - `description` string — A description of the custom recurring payment that will display to your user when they are redirected to their bank to accept the payment. > **Note**: We highly recommend that this message be in Brazilian Portuguese, and that it clearly explains the purpose as well as recurring nature of the payment. - `payer_institution` string, uuid — Unique identifier for the payer's institution. - `beneficiary_bank_account` string, uuid — Belvo's unique ID used to identify the beneficiary's bank account. - `payment_method_information` PaymentMethodInformationOfpi, required — Information about the payment method selected. - `open_finance` PaymentMethodInformationBodyOfpi — Payment method type selected. - `provider_request_id` string, nullable — Unique ID for the payment, as sent by the provider. - `redirect_url` string, nullable — The URL that redirects the user to their institution's website to authorize the payment. - `end_to_end_id` string, nullable — A unique ID for the transaction in the Brazil's PIX payment system. - `settlement_date` string, date — The `settlement_date` field indicates the date on which a scheduled payment (charge) is planned to be settled. This field is relevant in various states of the charge's lifecycle: - Scheduled Charges: When a charge has the status `SCHEDULED`, this field represents the planned settlement date. - Completed Charges: When a charge has the status `SUCCEEDED`, this field reflects the date that the payment was made. - Failed or Canceled Charges: When a charge has the status `CANCELED` or `FAILED`, this field will still contain the originally calculated settlement date, indicating when the charge was intended to be settled. > **Note**: The `settlement_date` does not change based on the success or failure of the charge. It consistently reflects the original planned settlement date. - `payer_information` ChargePayerInformation — Information about the ChargePayerInformation.yaml - `bank_account` object — Information about the payer's bank account. - `type` string — The type of the payer's bank account. Can be either `CHECKINGS`, `SAVINGS`, or `PAYMENTS`. - `agency` string — The agency number of the payer's bank account. - `number` string — The account number of the payer's bank account. - `institution_id` string, uuid — The Belvo institution ID of the payer's bank account. - `transactions` PaymentTransaction[] — An array of Transaction objects relating to the charge. - `id` string, uuid, required — Belvo's unique identifier for the current item. - `created_at` string, date-time, required — The ISO-8601 timestamp of when the data point was created in Belvo's database. - `created_by` string, uuid, required — The unique ID for the user that created this item. - `amount` string, required — The transaction amount. **Note**: The amount displayed is always positive as we indicate the direction of the transaction in `transaction_type` parameter. - `currency` 'BRL', required — The currency of the amount paid, for example, `BRL` (Brazilian Real). - `description` string, required — The description of the payment. - `transaction_type` 'INFLOW' | 'OUTFLOW', required — The direction of the transaction. - `INFLOW` indicates money coming into the account. - `OUTFLOW` indicates money coming out of the account. - `beneficiary` string, uuid, required — Belvo's unique ID used to identify the beneficiary's bank account. - `payer` unknown, required - `payment_intent` string, uuid — The unique ID of the payment intent associated with the transaction. - `customer` string, uuid — Belvo's unique ID for the customer asscociated with this transaction. - `failure_code` string, nullable, required — Error code that explains the reason behind a payment being unsuccessful (if applicable). - `failure_message` string, nullable, required — Further information regarding the `failure_code`. - `metadata` object, 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. ## Other responses - `401` — Unauthorized - `403` — Access to Belvo API denied - `404` — Not Found Error - `408` — Request Timeout - `500` — Unexpected Error --- [API](https://skmtc.net/belvo/apis/belvo-api-docs.md) · [All operations](https://skmtc.net/belvo/apis/belvo-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/belvo/belvo-api-docs/revisions/e82dca4a4b97/schema)