v1

latestOpenAPI 3.1.02026-07-2414704.6 MB

Create Link

Generate a unique payout link for easy payment disbursement without collecting bank details.

post/payout/link/create

Response

200

statuscodestring

{"stackTrail":"paths:/payout/link/create:post:responses:200:content:application/json:schema:properties:actcode","oasType":"schema","type":"unknown"}

statusstring

timestampstring

ipay_uuidstring

orderidstring

environmentstring

{"stackTrail":"paths:/payout/link/create:post:responses:200:content:application/json:schema:properties:internalCode","oasType":"schema","type":"unknown"}

Example response

{
  "statuscode": "TXN",
  "status": "Link Created Successfully",
  "data": {
    "linkId": "657aa9841b8d3897ff0a84fb",
    "url": "https://instant.pe/LS25FH",
    "status": "ISSUED",
    "contactDetails": {
      "name": "Instantpay India Limited",
      "mobile": "7428585742",
      "email": "help@instantpay.in"
    },
    "amount": 120.11,
    "purpose": "refund",
    "description": "Giving captch payment",
    "referenceNo": "NA",
    "verifyBene": true,
    "paymentModes": [
      "ACCOUNT"
    ],
    "orderId": "1231214070644TLWAP",
    "activatedAt": "2023-11-20 14:02:00",
    "expiredAt": "2024-03-13 12:36:44"
  },
  "timestamp": "2023-12-14 12:36:45",
  "ipay_uuid": "h0009ad84ae9-ddca-46ae-b631-b7ecda7b33d4-WmhQCUyFnkmi",
  "orderid": "1231214070644TLWAP",
  "environment": "PRODUCTION"
}