Generate LRS Payment Link

Generate a link to initate the LRS payment journey.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

This API is currently in internal beta and subject to change. The request and response payloads, API endpoint, and validation logic may be updated.


🙌

Important Note

Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.

Overview

  1. This API lets a platform generate a payment link to intiate LRS payments.
  2. The platform will have to first generate the customer profile (lrs_customer_id) via the Create LRS Customer API.
  3. The platform will receive the payment link in the API response which can be embedded within their checkout flow, app, or any third-party system or send it directly to the end customer via SMS, WhatsApp, etc.
  4. When the payer clicks on the link, they will land on the information collection or payment initiation stage depending on the details available against their customer profile.
  5. Once the payment has been completed, Decentro will trigger the Transaction Status Callback/Webhook to the platforms pre-configured endpoint with the transaction status.
  6. Alternatively, the platform can check the status of the payment using the Get Transaction Status API, using Decentro's transaction ID shared in the response of this API.

Currency Units

All amounts should be propagated in the base currency unit (example: Cents, Pence, Paisa, Centavos). Kindly convert primary currency unit into the base currency unit based on the table below.

Currency CodeDecimal Places
United States DollarUSD2
Body Params
string
required

A unique ID assigned by clients for every API request.

string
required

A unique identifier assigned to client's by Decentro during On boarding.

string
required

The unique ID assigned by Decentro for the Payer.

string
required

Amount to be collected, expressed in base currency units (e.g., Cents). Example, USD 99.00, should be passed as 9900.

integer
Defaults to USD

The currency in which the payment should be accepted. Please Note: This is not the same as the currency in which the payment will be completed by the Payer. Possible Value: USD.

string
Defaults to S0001

The LRS purpose code (reason) relevant for the payment. Possible Values: S0001.

string

Optional description which will be displayed to the payer on our checkout page.

integer
required

Time parameter in minutes after which the link will become expired. Minimum Value = 5 minutes. Maximum Value = 1440 minutes.

bank_code
array of strings

Optional parameter which will limit the banks available to the payer during checkout. When not defined, the payer will be shown either all available banks or the registered banks as per the details available against the lrs_customer_id

bank_code
string
Defaults to REDIRECT

Conditional Mandatory: Defines the payment experience which will be offer to the payer for the bank defined via bank_code. Possible Values: REDIRECT

redirect_url
object

The custom URL where the user will be redirected after the payment session. Only "https://" endpoints will be accepted.

Headers
string
required

Decentro assigned client_id during onboarding.

string
required

Decentro assigned client_secret during onboarding.

string

Optional header that allows parent merchant to consume the API on behalf of sub-merchant.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json