Our latest Deposits API is focused on simplicity, usability and personalization and it is used to allow your customers to deposit with their local payment methods of preference.
We work as a bridge between you and your customer's local payment methods such as banks, e-wallets, credit cards among others.
With only one integration, you have access to the most popular payment methods in the emerging markets.
In order to make that possible, we have developed our API v3 of Deposits allowing you to create payments directly from your own cashier or from one of ours in case you want us to take care of the fields needed for each country and payment method.
Our API v3 of deposits is meant to be used on the way that fits best to your needs and technical requirements.
With only one API, you can opt for different integrations:
- 1.Hosted Checkout Experience: We build the checkout page so you don't need to worry about collecting and validating the payment details.
- 2.OneShot Experience: You collect, validate and send all the details required for the payment, and you display the payment's metadata directly on your website or redirect the customers to the payment page.
- 3.V3 PCI: You collect and send to us the Credit Card details for processing. The payment is approved/rejected instantaneously. A PCI certificate is required for this integration.
The OneShot Experience is an integration where you send all the details required for the deposit and the customer itself and we will return you the metadata of the payment for you to build the payment page on your own website or a URL to redirect the customer to the payment page!
We call it OneShot because the customer only has to generate the payment on your cashier and pay.
Once the payment is generated, we will send a field specifying whether the payment experience can be done OneShot: native on your cashier with the metadata we give you or with Redirect.
This integration offers a more personalized user experience, as the user won't leave your site but for pay (if at all).
In order to make the payment creation process as smoother as possible and to avoid errors, in case you don't send a field that is required for the payment method/country, we will take care of it by asking the missing information to the customer on our Hosted Checkout instead of declining the payment
With this integration, it is a good idea to ask the customer to fill in their details only once and store them in your database so you don't have to ask them for those details each time and instead, you send us the information directly from your database. In case they need to modify something, they should do it from their profile and not from your cashier.
The Hosted Checkout Experience is a fast and easy-to-integrate solution where you will only need to send some basic details about the deposit itself, and we will generate a link you will use to redirect your customers to our Hosted Checkout where we will prompt them for any missing details like the payment method, the document, email and full name.
This experience is easier to integrate since we will control the payment methods availability in real time, validate all the fields and make sure everything runs smoothly without you worrying about what details every country/payment method specifically requires.
Once integrated, adding new payment methods and countries with this integration requires no further development on your end since we will take care of the user experience!
With this integration, you only need to send the amount and the country of the deposit and we will take care of the rest. The customers will be able to choose the payment method on our Checkout, input their data and pay!
If you already have the customer's name, email address, document ID or any other details on your database, you can opt for sending it on the request so we don't ask the customer for it again
The Hosted Checkout Experience, allows you to personalize our Checkout by sending details like the
payment_typeto group our payment methods on different sections of your page, the
strikethrough_amountto show a promo on our Hosted Checkout, the
descriptionto show them what they are paying for or even your own
logoso the customer can see it on our Hosted Checkout. All of that, with only one integration described here.
The API V3 PCI for Credit Cards Processing allows you to build your own Credit Card checkout form to collect and send to us the customer's credit card details, allowing for a Seamless experience without redirecting the customer to an external checkout.
With this integration you will be handling sensitive Credit Card data, therefore, we require you to be PCI Compliant and send us your PCI AOC certificate.
Follow this steps to start processing payments with the Directa24 Deposits API:
2 - Get Credentials: After your account has been activated, you will have access to your Staging (STG) Merchant Panel where you will need to
- Whitelist your IPs
- Retrieve your API Keys
Than can be done by going to Settings -> API Access.
3 - Integrate the APIs: Follow the instructions over this documentation to integrate our Deposits APIs.
In order to move your account from STG to PRODUCTION, there are a few tests you need to check you are able to do:
- Manually approve and cancel (at least) one deposit from the STG Merchant Panel
- Make sure you are receiving and handling our notifications correctly in your site according to response statuses and reject codes
4 - Go Live: Once you have completed the tests required in step 3, Request Go Live on the Home of the STG Merchant Panel to generate your account in our Production environment.
We will review your tests, if everything is fine you will receive an email to activate your account on our production environment. In case there is something missing, we will let you know!
5 - Process payments: Get the production credentials, whitelist your IPs on the production environment and start processing your payments with Directa24!
Don't get stuck! In case you have any technical doubts not covered on this documentation, reach out to [email protected] for assistance.
In order for you to start testing our Deposits APIs right away, we have prepared a Postman Collection you can use to test and validate your integration along with the functionalities we offer.
Make sure you replace the
secretKeyvalues with your own API Key and API Signature deposit credentials