This page outlines the integration Guide for Decentro's Payment Link Product
1. Introduction
This guide provides a comprehensive integration pathway for Decentro customers to effectively integrate with Decentro’s Payment Link product.
2. Prerequisites
2.1 Connected Account KYC
Before integrating with Payment Links, platforms must complete the Connected Account KYC process.
2.2 Payment Link KYB
Before generating Payment Links on production environment, the platforms must complete the Payment Link KYB process.
Notes:
- Payment Link KYB is different from the Connected Account KYC that is done during the time of platform onboarding.
- Connected Account KYC is done to enable platforms to use Decentro's Virtual Account Collections and Payout products.
- Payment Link KYB is done to enable platforms to use Decentro's Payment Link product.
2.3 Access to Decentro APIs
2.3.1 Staging (Demo) Environment
Customers will get access to staging (demo) environment APIs even before completing the Connected Account KYC and Payment Link KYB processes.
2.3.2 Production (Live) Environment
Customers will get access to production environment only after successful completion and approval of their connected account KYC and payment link KYB.
3. Integration Overview
3.1 Payment Link KYB
- Payment link KYB is mandatory for all the platforms.
- Payment link KYB can only be initiated after the successful submission of Connected Account KYC by the platform.
- Payment Link KYB requires the platforms to share the following details with Decentro -
- Trading Name
- Website
- Industry
- Product Description
- Transaction related details
- Average Transaction Size (USD)
- Maximum Transaction Size (USD)
- Average Monthly Volume (USD)
- Percentage of products or services provided to international customers
- Delivery time of product/services
- Goods/services are provided before the customers pay for their orders
- Goods/services are provided after the customers have paid for their order - provide delivery timeline (days)
- Do the platform have an existing payment solution provider?
- Platforms are required to share the above details with Decentro's customer success team to initiate the Payment Link KYB.
- Once the platform has shared these details, Decentro reviews the KYB and informs the platform after the KYB is approved.
3.2 Payment Link Generation and Web Hook Management
3.2.1 Generating Payment Links
- Platforms can start generating payment links using Decentro's Generate Payment Link API. In order to do, platforms need to provide the following information in the API request payload -
- Reference Id - A unique reference id to identify this transaction
- Virtual Account Unique Reference Number - URN of the virtual account on which the platform wants to accept this payment. To create a virtual account, the platforms can use Decentro's Create Virtual Account API
- Currency - The currency in which the platform wishes to receive funds collected through the payment link. If the payer's currency differs from the platform's specified currency, Decentro automatically converts the collected funds into the specified currency and settles the amount to the platform.
- Amount - The amount to be collected in the currency specified by the platform. If the payer's currency is different, Decentro will collect the equivalent amount in the payer's currency, convert it to the specified currency, and settle the funds with the platform.
- Title - Any title that the platform wants to specify for this transaction. The same title will appear on the browser checkout page where the payer will pay.
- Description - Any description that the platform wants to specify for this transaction. The same description will appear on the browser checkout page where the payer will pay.
- Expiry - If the platforms want to set an expiry for the payment link, they can pass the expiry timestamp and payment link becomes inactive after that timestamp.
- The successful execution of the Generate Payment Link API will generate a payment link URL in the response payload of the API
- Platforms can then use this payment link URL to embed in their web/mobile platforms or directly share with their payers over WhatsApp, SMS and Email etc
- When the payer clicks on the payment link URL, they are redirected to a securely hosted browser checkout page where they are required to share their card details.
- Once the payer has shared their card details correctly, they have to authenticate the payment by entering the OTP sent to their mobile number by the card network.
- This completes the payment link transaction journey.
3.2.2 Integration Flow Chart
3.2.3 Web Hook Management
- When the payment link is successfully created, the status of the payment link becomes ACTIVE. This status will be received in the response of the Generate Payment Link API
- Once the payer successfully pays on the payment link, Decentro notifies the platforms via the Payment Link Status Web Hook. At this stage the status shared in the web hook will be CHECKED_OUT
- After Decentro has received the transaction, Decentro settles the transaction in platform's connected account wallet. Once the transaction is successfully settled in the platform's connected account wallet, Decentro notifies the platform via the Payment Link Status Web Hook. At this stage the status shared in the web hook will be SETTLED
- If the platform specifies an expiry time and payer fails to pay on the payment link within the expiry time, Decentro notifies the platforms with the Payment Link Status Web Hook. At this stage the status shared in the web hook will be EXPIRED
- Other than the above web hook events, Decentro also shares a INACTIVE status in the Payment Link Status Web Hook . Inactive status is sent either after the successful payment on the payment link or if the payment link expires