Partner API — v2.6.0

Type: Minor Release  ·  Previous version: v2.5.4

---

✅ 2 New ✏️ 2 Modified 🚫 2 Deprecated

---

✅ New Endpoints

POST /tenant/customer/api/otp/request

Tag: Customer Email Verification
Summary: Request otp for customer email verification

Request Body

Field	Type	Required	Description
email	string	Yes	customer email e.g. email@testemail.com

Example Request

{
  "email": "email@testemail.com"
}

Response Codes

Code	Description
201	Success Response when OTP generated successfully
400	Error response when OTP generation got failed

201 — Success Response when OTP generated successfully

{
  "data": {
    "verification_request_id": "97673401-793e-4533-8b83-85bdf6c59409"
  },
  "message": "OTP has been sent on provided email."
}

400 — Error response when OTP generation got failed

{
  "errors": [
    {
      "type": "Email Verification",
      "message": "OTP generation got failed."
    },
    {
      "type": "Invalid UUID",
      "message": "Please provide valid tenant id"
    },
    {
      "type": "Tenant",
      "message": "Tenant not found"
    }
  ]
}

---

POST /tenant/customer/api/otp/verify

Tag: Customer Email Verification
Summary: Verify otp for customer email verification

Request Body

Field	Type	Required	Description
otp	string	Yes	otp to verify email e.g. 123456
verificationRequestId	string	Yes	verification request Id e.g. 969a1166-8664-4820-9cf7-76a82f076544

Example Request

{
  "otp": "123456",
  "verificationRequestId": "969a1166-8664-4820-9cf7-76a82f076544"
}

Response Codes

Code	Description
201	Success Response when OTP verified successfully
400	Error response when OTP verification got failed
401	Error response when OTP verification got unauthorized
404	Error response when verification request details not found
409	Error response when OTP verification got conflict
429	Error response when OTP verification got reach allowed limits

201 — Success Response when OTP verified successfully

{
  "message": "Email verified successfully."
}

400 — Error response when OTP verification got failed

{
  "errors": [
    {
      "type": "Email Verification",
      "message": "Invalid OTP"
    },
    {
      "type": "Email Verification",
      "message": "OTP expired or incorrect"
    }
  ]
}

401 — Error response when OTP verification got unauthorized

{
  "errors": [
    {
      "type": "Email Verification",
      "message": "OTP expired or incorrect"
    }
  ]
}

404 — Error response when verification request details not found

{
  "errors": [
    {
      "type": "Email Verification",
      "message": "No OTP request found"
    }
  ]
}

409 — Error response when OTP verification got conflict

{
  "errors": [
    {
      "type": "Email Verification",
      "message": "OTP already verified"
    }
  ]
}

429 — Error response when OTP verification got reach allowed limits

{
  "errors": [
    {
      "type": "Email Verification",
      "message": "Too many failed attempts"
    }
  ]
}

---

✏️ Modified Endpoints

POST /digital-wallet/deposit

Tag: Digital Wallet
Summary: Deposit via digital wallet in wallet user account

Updated Request Body Fields

cancelUrl (string)

• Example updated: https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/cancel

failureUrl (string)

• Example updated: https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/failure

successUrl (string)

• Example updated: https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/success

Current Request Example

{
  "amount": 0,
  "namespace": "test.jones1.ul",
  "successUrl": "https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/success",
  "failureUrl": "https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/failure",
  "cancelUrl": "https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/cancel",
  "ipAddress": "127.0.0.1",
  "token": "THAI"
}

Response Examples

Code	Description
201	Success Response when url is fetched successfully
400	Error response for all possible cases when calling add fund api gets failed.

201 — Success Response when url is fetched successfully

{
  "data": {
    "url": "https://www.sandbox.paypal.com/checkoutnow?token=6KY73853N7081953X",
    "fiatTransactionId": "dca665ae-ffae-4249-9b5b-31439d470258",
    "fiatStatus": "PENDING",
    "namespace": "digit.sheetalku55.ul",
    "amount": 87,
    "fiatTransactionHistory": {
      "fiatTxnHistoryId": "be02917c-c515-4579-9e99-a159f81bb333",
      "status": "PENDING",
      "description": "Digital wallet transaction status is initiated, default status is pending.",
      "createdAt": "2024-07-19T07:48:20.0000000+00:00"
    }
  }
}

400 — Error response for all possible cases when calling add fund api gets failed.

{
  "errors": [
    {
      "type": "Add Fund",
      "message": "please enter namespace of user"
    },
    {
      "type": "Add Fund ",
      "message": "no payment provider detail found"
    },
    {
      "type": "Add Fund",
      "message": "Something went wrong, please try again"
    }
  ]
}

---

POST /transaction/add-fund

Tag: Payment
Summary: fetch add fund url for wallet user account

Updated Request Body Fields

cancelUrl (string)

• Example updated: https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/cancel

failureUrl (string)

• Example updated: https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/failure

successUrl (string)

• Example updated: https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/success

Current Request Example

{
  "amount": 0,
  "namespace": "test.jones1.ul",
  "successUrl": "https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/success",
  "failureUrl": "https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/failure",
  "cancelUrl": "https://console-dev.cab340b7670d495a8ed7.eastus.aksapp.io/payments/cancel",
  "ipAddress": "127.0.0.1",
  "token": "THAI"
}

Response Examples

Code	Description
201	Success Response when url is fetched successfully
400	Error response for all possible cases when calling add fund api gets failed.

201 — Success Response when url is fetched successfully

{
  "data": {
    "namespace": "blrwizards.sheetalstagk.ul",
    "url": "https://pay.sandbox.checkout.com/page/hpp_CizJqjrq23?_pcf"
  }
}

400 — Error response for all possible cases when calling add fund api gets failed.

{
  "errors": [
    {
      "type": "Add Fund",
      "message": "please enter namespace of user"
    },
    {
      "type": "Add Fund ",
      "message": "no payment provider detail found"
    },
    {
      "type": "Add Fund",
      "message": "Something went wrong, please try again"
    }
  ]
}

---

🚫 Deprecated Endpoints

Deprecated in this version

• GET /tenant/customer/wallet/financial-badges-token-combination — Fetch wallet level financial badge with tokens details

• POST /tenant/customer/modify-wallet-financial-badge — Modify wallet financial badge