Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Transfer Customer Points

Transfers points from one customer account to another customer account by validating the OTP issued for the points transfer.

post/points/transfer

Request body

pointsTobeTransferredinteger required

Number of points to be transferred.

programIdinteger

Program ID from which points has to be transferred. Applicable for multi-program orgs.

groupProgramTransferboolean

Pass true to transfer group points.

notesstring

A short note on the points transfer.

codestring

Pass the OTP received by the fromCustomer for the current points transfer. To issue OTP, use either /isPointsTransferrable or /issuePointsTransferOtp.

Response

201

Example response

{
  "data": [
    {
      "toEntityId": 565039506,
      "toEntityType": "CUSTOMER",
      "fromEntityId": 565039505,
      "fromEntityType": "CUSTOMER",
      "pointsTransferDate": "2025-06-02 07:24:58",
      "pointsTransferred": 2000,
      "transferId": 1037890,
      "transferType": "DEDUCTION",
      "transferredFrom": {
        "userId": 565039505
      },
      "transferredTo": {
        "userId": 565039506,
        "firstName": "Madhurima",
        "lastName": "Basak"
      },
      "programName": "DocDemoDefaultProgram",
      "pointsTransferBreakupByEarningPrograms": [
        {
          "programId": 973,
          "deductedPoints": 1000,
          "programCurrentPoints": 7500
        }
      ]
    }
  ]
}