Sign in

v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB
Payment Links

Create Link

This API will be used to create a link for the customer to make a payment and the merchant can choose the medium for dissemination of the link- Email, SMS or both.

post/create

Headers

BD-Traceidstring required
Example:20201203182838

BD-TraceID is a unique identifier passed by the merchant to ensure request idempotency. Requests with identical BD-TraceID within a 24 hour window would fail.

BD-Timestampstring required
Example:20201203182838

Request timestamp to identify date and time of origin of request. Example, a value of BD-Timestamp 20210113180403 identifies the request to have originated on 13th January 2021 at 06:04:03 PM.

Content-Typestring required
Example:application/json

Request Content-Type to take the values application/jose

Acceptstring required
Example:application/jose

Accept Response Content-Type to take the values application/jose

Request body

Example request

{
  "data": {
    "mercid": "BDMERCID",
    "merc_link_ref_no": "testlink01",
    "flow_type": "payment",
    "payment_method_allowed": "card,upi",
    "payment": {
      "amount": "299.28",
      "minimum_partial_amount": "50",
      "avs": {
        "bankaccounts": [
          {
            "number": "12233445566",
            "ifsc": "IDBK10000002",
            "name": "John Doe"
          }
        ]
      }
    },
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "mobile": "9022979988",
      "email": "abc@xyz.com"
    },
    "udf": [
      {
        "sequence": 1,
        "field_label": "Quote number",
        "field_value": "162728383"
      }
    ],
    "additional_info": {
      "additional_info1": "Details1",
      "additional_info2": "Details2",
      "additional_info3": "Details3",
      "additional_info4": "Details4",
      "additional_info5": "Details5",
      "additional_info6": "Details6",
      "additional_info7": "Details7"
    },
    "forwarding_url": "https://www.merchant.com",
    "link_expiry_date": "2024-08-14T17:57:31.262889064",
    "link_title": "Instagram Purchase",
    "link_desc": "Apparel - Format shirt, Trousers - 4 nos."
  }
}

Response

OK

Example response

{
  "data": {
    "linkid": "LP20240701lepFL",
    "mercid": "BDMERCID",
    "merc_link_ref_no": "testlink01",
    "flow_type": "payment",
    "payment": {
      "amount": "299.28",
      "minimum_partial_amount": "299.28"
    },
    "udf": [
      {
        "sequence": 1,
        "field_label": "Quote number",
        "field_value": "162728383"
      }
    ],
    "additional_info": {
      "additional_info1": "Details1",
      "additional_info2": "Details2",
      "additional_info3": "Details3",
      "additional_info4": "Details4",
      "additional_info5": "Details5",
      "additional_info6": "Details6",
      "additional_info7": "Details7"
    },
    "forwarding_url": "https://www.merchant.com",
    "link_expiry_date": "2024-08-14T17:57:31.262889064",
    "link_desc": "Apparel - Format shirt, Trousers - 4 nos.",
    "link_title": "Instagram Purchase"
  }
}