Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Transfer Group Points

Lets you transfer points from one account to another account - group to customer, customer to group, or group to group.

post/points/userGroup2/transfer

Request body

pointsTobeTransferredinteger required

Number of points to be transferred.

programIdinteger required

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

200

OR
OR

Example response

{
  "data": [
    {
      "toEntityId": 418400980,
      "toEntityType": "CUSTOMER",
      "fromEntityId": 2626,
      "fromEntityType": "USERGROUP2",
      "pointsTransferDate": "2021-10-07 16:36:12",
      "pointsTransferred": 10,
      "transferId": 6545,
      "transferType": "DEDUCTION",
      "transferredTo": {
        "userId": 418400980
      },
      "transferredFromUserGroup2": {
        "id": 2626,
        "groupStatus": "ACTIVE",
        "fleetGroupUsers": [
          {
            "userId": 418400982,
            "groupId": 2626,
            "defaultGroup": true,
            "active": true,
            "primaryMember": true
          }
        ],
        "createdBy": 15089282,
        "createdOn": "2021-10-07T15:42:02+05:30",
        "lifeTimePurchases": 400
      },
      "notes": "notes123",
      "programName": "SunRiseDefaultProgram",
      "pointsTransferBreakupByEarningPrograms": [
        {
          "programId": 765,
          "deductedPoints": 10,
          "programCurrentPoints": 70
        }
      ]
    }
  ]
}