Introduction

Our Payment Initiation (PI) API allows you to receive payments into a specific Brazilian bank account, from now on, called a Creditor Account, through a well-designed Payment page that requires zero effort to implement.

Using Payment Initiation as the payment method allows users to have more control over an OAuth experience with their financial institution to confirm the transaction.

Get Started

In order to use our Payment Initiation API, you will need to:

• Ask our customer success team to enable this feature for you!
  They will also invite you to a private Slack channel, where our engineers will help with your integration.
• Create callbacks for your payments whether the payment was fulfilled (success) or it was canceled/failed (error).
• Setup your recipient destination account, by using our API you can create the default recipient for all payments, or you can configure different ones that will be used on each request.

And that's it! After that, you are ready to integrate with our API and start to receive payments.

Glossary

Customer

It's the client that will fulfill the payment, we request some details like CPF, Name, or Email, that will improve their experience while paying, skipping some steps to complete further details. Even though it's not required, we encourage it to provide the best UX.

Recipient

The destination account, or bank beneficiary, its where the money will be sent when the payment its completed. It's mandatory to complete a default recipient for all payments, which will be used when the payment request, doesn't have any recipient. If not, multiple recipients can be created and used in different requests.

Payment Request

A Request is like an order, where you configure the amount, description, expiration, and other settings, to create a payment URL to our Payments Page that could be shared with customers through your communication systems or just redirected to it.

Payment Intent

An intent is an end user trying to fulfill the payment, every time the user goes through the payment gateway, there will be a new intent linked to it. Once the payment has been completed, the Request will change to complete.