Introduction
Pluggy's Payment Initiation API makes payments instant, easy, and secure. Here we describe in a simple way how you can implement it in your payment flows.
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 request to you some details about the Creditor Account, so the payment destination is configured.
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).
And that's it! After that, you are ready to integrate with our API and start to receive payments.
Glossary
Payment Request
A Request is like an order, where you configure the amount, description, expiration, plus some 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.
Updated 20 days ago