Direct API

The Direct API Integration allows you full customization of the checkout your customer will see.

After creating the transaction in our system via the POST transaction endpoint, you will have the posibility of using our GET Landing Info API call or JavaScript library to retrieve the payment instructions normally displayed on the payment method checkout page. After getting those elements, you can create your own checkout page and display payment instructions directly on your website, allowing users to complete the payment process without redirection.

Important: to note that as of now this API call is not compatible with all of the payment methods available through Payretailers.

To get started navigate to the Get Landing Info. section of our API Reference.

🚧
Compatible Payment Methods
Only certain payment methods are currently compatible with this API call.

Supported Payment Methods

This customisation feature is currently available for the following payment methods:

Argentina

QR Code
Pago Facil
Rapipago

Brazil

PIX
Picpay
Boleto Rápido

Colombia

Efecty

Mexico

SPEI

Peru

Pago Efectivo

Direct API Integration Flow

Contrary to the other types of integration, the flow here starts after creating a transaction. After the user has chosen their payment method, instead of redirecting them to the payment method’s checkout page, proceed with the following steps:

Create a Transaction in our system via the POST Transaction endpoint;
Obtain the ID of the transaction from the response of your transaction request;
Use this ID to make a Get Landing Info request;
Retrieve the necessary payment instructions from the Get Landing info body and display it on your checkout page.

The user should be able to follow the payment instructions from your checkout page and complete the payment. The transaction will then follow the normal status flow.

Direct API Integration Flowchart

This flowchart illustrates the Direct API integration flow explained above.