API
Overview
To effectively establish communication between your API and the Gini Request-To-Pay service, ensure you've secured the required credentials: client Id and client secret. Without these, you are not going to be able to connect with our API. If you haven't yet obtained them, refer to this page. Once ready, follow this recipe to integrate the Request-To-Pay service with the API to API implementation.
In the majority of the use cases, the mobile or web recipes will work for you. In order to use the API to API integration, you are going to be in charge of a lot of the UI functionalities, but you are going to have full ownership of it as well.
Diagram of the Web Integration Flow
Get payment providers
You first need to get the payment providers in order to be able to show the needed bank picker and button for initiating the RTP payment. For deep documention on it, you can go to the API reference for this endpoing here.
After you successfully obtain these payment providers, you must show the user the picker and the
Init RTP Payment
After the user selects the preferred bank and clicks on the RTP button, you can now initiate the RTP payment. The full documentation on this endpoint can be found here.
In the response of this endpoint, you are going to receive an RTP Id, and a deeplink URI (rtpBankUri) in order for you to handle correctly the showing of the QR code (if your customer is on a web desktop environment), or to execute the deeplink in any other case. This, will open customer's bank application, where the payment will be handled.
After it, you are going to receive a webhook once the payment have finished (success or failure). If you need, you can also check the payment status using this endpoint.