PSE Prerequisites

Intro

Before you can make use of our solution to make payments, we need to get you onboarded. During the process, we'll:

  • provide you with the provider’s Terminal ID and Form ID needed to process payments

👍

Get in touch!

If you would like to get started using Belvo’s Payments API, just contact us at [email protected] and we’ll get right to it. 🙂

Once you are all set up, you can use Belvo's PSE product to request payments from your users in as little as two steps!

  1. Create your Payments secret keys. Make sure you've already created your Belvo account. For instructions on how to generate your Payments secret keys, see Authentication (Payments).

  2. Register your webhook so we can let you know about important events during the payment process, such as payment confirmations. For instructions on how to register your Payments webhooks, see Webhooks (Payments).

  3. Register your beneficiary bank account (this is the account that will receive all successful payments).

  4. (Optional) Have your callback URLs prepared. These are URLs that the user should be redirected to when they complete or cancel a payment, or if an error occurs during the payment process.

All these steps are required in order to use our Payments API, but you just need to do it once and you're ready!

Postman collection

We’ve created a public Postman collection for you to quickly get set up using Belvo’s Payment Initiation API (PSE). 😉

Register your organization’s bank account

Your organization’s bank account (the beneficiary) will collect all successful payments. To create your business bank account, you need to make a POST Create a new bank account call to our Bank Accounts resource.

{
     "holder": {
          "type": "BUSINESS",
          "information": {
               "name": "the_name_of_your_business"
          }
     },
     "providers": {
          "payments_way": {
               "terminal_id": "the_provider's_terminal_id", // Provided by Belvo
               "form_id": "the_provider's_form_id", // Provided by Belvo
          }
     },
  	"number": "beneficiary_bank_account_number"
}
{
     "holder": {
          "type": "BUSINESS",
          "information": {
               "name": "Trusty documentation services"
          }
     },
     "providers": {
          "payments_way": {
               "terminal_id": "123",
               "form_id": "321",
          }
     },
  	"number" "12343453245633"
}

You’ll receive the following response from our API. Make sure you save the id from the response - you’ll use it as the beneficiary_bank_account in the future when you create payment links. 🤓.

{
  "id": "7c2be016-37e3-44e2-8643-db2eb1129a3f",
  "created_at": "2023-02-15T07:52:31.998761Z",
  "created_by": "417514fe-50f6-42e9-a3eb-c71da00f014c",
  "holder": {
    "type": "BUSINESS",
    "information": {
      "name": "Tr******es"
    }
  },
  "providers": {
    "payments_way": {
      "terminal_id": 123,
      "form_id": 321
    }
  },
  "number": "******5633"
}

Have your callback URLs ready

These are URLs that you’ll need to provide in a payment link request and will redirect your customer when they complete or cancel a payment, or if an error occurs during the payment process. You’ll need to provide cancel and success URLs:

"callback_urls": {
  "cancel": "https://www.acmecorp.com/checkout/3487548/cancel",
  "success": "https://www.acmecorp.com/checkout/3487548/success"
}  

📘

You won't need to provide callback URLs if your integration only generates payment links through the Belvo Dashboard. 🙂

What's next?

And you're all set! To start collecting payments from your customers, check our PSE Inflow Payments guide! :money-with-wings: