Environments

With our Direct Debit product, you have access to two environments for testing and real-world payments:

Sandbox

📘
We really recommend that while you're integrating with Belvo, you start with the Sandbox environment and then proceed to Production.

Available for:

🟢 Payments (Direct Debit Mexico)

Use our Sandbox environment to build your integration. In this environment, you can:

Use our no-code Bulk Imports tool to mock batch payments.
Use our API to create Customers, Payment Methods, Generate Agreements, and Payment Requests.
Use our Reporting tools to see how the reconciliation process works.

All you need to get started with the Sandbox environment is to sign up in the Sandbox portal and verify your email address. After that, depending on your needs you can:

Follow our dedicated Bulk Import Direct Debit Payments (No Code) guide to get started with mock payments.
Generate some sandbox API keys and Set Up a Direct Debit (API).

Sandbox status updates

To mimic real-world situations, we've provided the following flows for payment methods and requests:

Payment Methods

When creating a payment method, set the bank to mx_santander.

Payment requests

When making payment requests, depending on the flow you want to test, you will need to provide different keywords as the value for the reference field.

Flow	Reference	Result
Success	`successful`	The payment request follows these statuses: `initial` -> `processing` -> `successful`.
Failed	`failed`	The payment request follows these statuses: `initial` -> `processing` -> `failed`.
Chargeback	`chargeback`	The payment request follows these statuses: `initial` -> `processing` -> `successful`->`chargeback`.
Default	(blank)	The payment request follows these statuses: `initial` -> `processing` -> `successful`.

Production

Available for:

🟢 Payments (Direct Debit Mexico)

Our Production environment will give you access to real payments to and from accounts using the Direct Debit platform.

After you have tested your integration in the Sandbox environment and are ready to go live, you'll need to reach out to our support team to access to our Production environment. Our support team will get in contact with you to schedule a meeting just to make sure your needs are satisfied, and then you'll just need to go through a certification process with one of our engineers to make sure that your integration is running optimally.

Once your integration is certified, all you'll need to do is sign up in the Production portal and verify your email. After this, if you're using our API you'll need to:

Generate some production API keys.
Change your Sandbox API keys in your code to the Production API keys.
Change the base URL that you make requests to from api.sandbox.directdebit.belvo.com to api.directdebit.belvo.com.
Set up your production webhook URL.

API keys and Authentication

Generate API Keys

To get your API keys:

Log in to your Direct Debit Portal. (Sandbox Login | Production Login)
Go to Developers -> API Keys. (Sandbox API Keys | Production API Keys)
Click Generate API Keys.
Save your Secret Key and Secret Password (they will only be displayed once).
After saving and downloading your secret key and password, click Done.

✅ You're API keys are successfully generated.

Authentication

After getting your Secret Key and Secret Password, provide them in the corresponding headers whenever making a request to a protected endpoint.

curl --request <the_method> \
     --url https://api.sandbox.directdebit.belvo.com/<the_endpoint>
     --header 'api-key-id: <Your secret-key-id>' \
     --header 'api-key-secret: <Your secret-password>'