Sign in

v1

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

Create a new Payment Intent

Create a Payment Intent.

You can create Payment Intent in the following configurations:

BeneficiaryCustomer (Payer)Example
Pix KeyAlready registered with BelvoPix Key (With Existing Customer)
Pix KeyRegister with Belvo at time of Payment Intent requestPix Key (With New Customer)
Bank Account (Already Registered)Already RegisteredBank Account (With Existing Customer)
Bank Account (Already Registered)Register with Belvo at time of Payment Intent requestBank Account (With New Customer)
Bank Account (Register at time of Payment Intent request)Register with Belvo at time of Payment Intent requestBank Account (With New Customer and Beneficiary Bank Account)

{% admonition type="warning" name="Pix Payments" %} When you create Payment Intents using a Pix Key, you have to make a PATCH Complete a Payment Intent request to complete the Payment Intent creation. {% /admonition %}

post/payments/br/payment-intents/

Headers

Belvo-Idempotency-Keystring uuid
Example:82737f32-7730-4832-a985-dd86df70301c

A UUID to ensure idempotent requests. This key helps prevent duplicate operations by allowing the server to recognize repeated requests with the same key and return the original response instead of processing the request again.

{% admonition type="info" name="Highly Recommended" %} We highly recommend including this header in any request where you want to ensure idempotency, such as creating resources or performing actions that should not be duplicated. {% /admonition %}

You may receive the following errors in the case that there is an issue with your request:

  • 409 Conflict: If a previous request is still being processed with the same idempotency key. Check the response Belvo-Idempotency-Status header for the current state of that idempotency key.
  • 422 Unprocessable Entity: If a new request uses an idempotency key that has been previously used in another request containing a different payload. In this case, you should change the idempotency key to a new unique value.

{% admonition type="warning" name="In Beta" %} This feature is currently in Beta and only available for selected customers. If you encounter any issues or are interested in using this feature, please contact your Belvo representative. {% /admonition %}

Request body

OR
OR
OR
OR

Example request

{
  "amount": "1234.12",
  "customer": "06dc2f14-1217-4480-9b36-550a944a39d1",
  "external_id": "4b8a81a0-e33c-45a6-8567-479efb105f73",
  "description": "Shoe payment",
  "statement_description": "Super Shoe Store - Brown Sneakers",
  "allowed_payment_method_types": [
    "open_finance"
  ],
  "payment_method_details": {
    "open_finance": {
      "pix_key": "53497b80-81a2-4ea8-9296-83a909c05bdf",
      "payer_institution": "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0",
      "callback_url": "https://www.acmecorp.com/checkout/3487321",
      "schedule": {
        "single": {
          "date": "2024-10-22"
        }
      }
    }
  },
  "metadata": {
    "internal_reference_id": "GGq73487w2"
  },
  "provider": "belvo"
}

Response

OK (Created)

OR