API Documentation
Start typing to search…

Transfer Group Points

post https://{host}/v2/points/userGroup2/transfer

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

Resource information

URIv2/points/userGroup2/transfer
HTTP MethodPOST
Pagination supported?NA
Rate limitNA
Batch supportNA
Authentication type supportedBasic or OAuth

Request Body Parameter

Parameter (Parameters marked in * are mandatory)TypeDescription
pointsTobeTransferredIntegerNumber of points to be transferred.
programId*IntegerID of the loyalty program from which points are deducted.
notesStringAdditional notes or comments about the transfer.
transferredBy*ObjectDetails of the entity initiating the transfer. It is required for all transfers except individual-to-group point transfers.
-identifierType*StringType of identifier used
-identifierValue*StringValue of the identifier
-sourceStringSource system initiating the transfer (e.g., "INSTORE").
-accountIdStringAccount ID associated with the transfer initiator.
toEntity*ObjectDetails of the entity receiving the points.
-type*StringType of the receiving entity (e.g., "USERGROUP2").
-identifierType*StringType of identifier used
-identifierValue*StringValue of the identifier
-accountIdStringAccount ID associated with the recipient.
-sourceStringSource system of the recipient (e.g., "INSTORE").
fromEntityObjectDetails of the entity sending the points.
-typeStringType of the sending entity
-identifierType*StringType of identifier used
-identifierValue*StringValue of the identifier
{
    "pointsTobeTransferred": 1,
    "programId": 973,
    "notes": "notes123",
    "transferredBy": {
        "identifierType": "id",
        "identifierValue": "565345942",
        "source": "INSTOREwe",
        "accountId": "textgrp22"
    },
    "toEntity": {
       "type": "USERGROUP2",
        "identifierType": "id",
        "identifierValue": "3847940",
        "accountId": "textgrp21",
        "source": "INSTORE"
    },
    "fromEntity": {
        "type": "CUSTOMER",
        "identifierType": "id",
        "identifierValue": "565345942"
    }
}

Response Parameter

ParameterTypeDescription
dataArrayContains the list of points transfer records.
toEntityIdIntegerThe ID of the entity receiving the points (e.g., UserGroup2).
toEntityTypeStringThe type of entity receiving the points (e.g., "USERGROUP2").
fromEntityIdIntegerThe ID of the entity sending the points
fromEntityTypeStringThe type of entity sending the points (e.g., "CUSTOMER").
pointsTransferDateStringThe timestamp when the points transfer occurred (YYYY-MM-DD HH:MM:SS).
pointsTransferredFloatThe number of points transferred.
transferIdIntegerA unique identifier for the transfer.
transferTypeStringThe type of transfer
transferredFromObjectDetails of the sender (Customer).
userIdIntegerThe user ID of the sender.
firstNameStringThe first name of the sender.
lastNameStringThe last name of the sender.
externalIdStringThe external identifier of the sender.
transferredToUserGroup2ObjectDetails of the recipient (UserGroup2).
idIntegerThe ID of the UserGroup2.
externalIdStringThe external identifier of the UserGroup2.
groupStatusStringThe status of the group (e.g., "ACTIVE").
fleetGroupUsersArrayList of users in the group
createdByIntegerThe user ID of the creator of the group.
createdOnStringThe timestamp when the group was created.
groupNameStringThe name of the UserGroup2.
maxGroupSizeIntegerThe maximum allowed size of the group.
lifeTimePurchasesIntegerThe lifetime purchases associated with the group.
notesStringAdditional notes related to the transfer.
programNameStringThe name of the loyalty program.
pointsTransferBreakupByEarningProgramsArrayBreakdown of points deducted per earning program.
programIdIntegerThe ID of the earning program.
deductedPointsFloatThe points deducted from this program.
programCurrentPointsIntegerRemaining points in the program after deduction.
{
    "data": [
        {
            "toEntityId": 3847940,
            "toEntityType": "USERGROUP2",
            "fromEntityId": 565345942,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-05-26 09:32:42",
            "pointsTransferred": 2.0,
            "transferId": 1037706,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565345942,
                "firstName": "firstname21",
                "lastName": "lastname21",
                "externalId": "73818141"
            },
            "transferredToUserGroup2": {
                "id": 3847940,
                "externalId": "testgrp201externalId201",
                "groupStatus": "ACTIVE",
                "fleetGroupUsers": [],
                "createdBy": 75155295,
                "createdOn": "2025-04-04T09:26:46Z",
                "groupName": "name_sant201",
                "maxGroupSize": 110,
                "lifeTimePurchases": 78000
            },
            "notes": "notes123",
            "programName": "DocDemoDefaultProgram",
            "pointsTransferBreakupByEarningPrograms": [
                {
                    "programId": 973,
                    "deductedPoints": 1.000,
                    "programCurrentPoints": 992
                }
            ]
        }
    ],
    "warnings": [],
    "errors": []
}

{
    "warnings": [],
    "errors": [
        {
            "status": false,
            "code": 422,
            "message": "pointsToBeTransferred value is invalid"
        }
    ]
}

{
    "warnings": [],
    "errors": [
        {
            "status": false,
            "code": 434,
            "message": "Invalid transferredBy.identifierValue set in the request payload"
        }
    ]
}

API Specific Error Code

  <th>
    Description
  </th>

  <th>
    Reason
  </th>
</tr>

  <td>
    points transfer to entity details not set/invalid
  </td>

  <td>
    `toEntity` object is missing
  </td>
</tr>

<tr>
  <td>
    422
  </td>

  <td>
    pointsToBeTransferred value is invalid
  </td>

  <td>
    `pointsToBeTransferred` value is either invalid or missing.
  </td>
</tr>

<tr>
  <td>
    434
  </td>

  <td>
    Invalid transferredBy.identifierValue set in the request payload
  </td>

  <td>
    * `identifierType` is invalid. <br>
    * Invalid `identifierValue` for `identifierType` = `id`.\
      Ensure that the data type provided is an integer.
  </td>
</tr>

<tr>
  <td>

  </td>

  <td>

  </td>

  <td>

  </td>
</tr>

<tr>
  <td>
    807
  </td>

  <td>
    Redemptions points not divisible
  </td>

  <td>
    Redemption points must be in whole numbers.
  </td>
</tr>

<tr>
  <td>
    830
  </td>

  <td>
    User does not have permissions to transfer points from this entity
  </td>

  <td>
    User lacks permissions to transfer points.
  </td>
</tr>

<tr>
  <td>
    885
  </td>

  <td>
    Invalid program id passed
  </td>

  <td>
    Program ID is invalid or missing.
  </td>
</tr>

<tr>
  <td>
    1206
  </td>

  <td>
    points transfer from entity details not set/invalid
  </td>

  <td>
    `fromEntity` object is missing.
  </td>
</tr>

<tr>
  <td>
    1208
  </td>

  <td>
    points transfer entity type not set/invalid.
  </td>

  <td>
    The `identifierValue` or `identifierType` in`to entity` object is invalid or missing.
  </td>
</tr>

<tr>
  <td>
    1645
  </td>

  <td>
    group details passed are not valid
  </td>

  <td>
    Group Id in `toEntity`object is invalid or missing.
  </td>
</tr>

<tr>
  <td>
    8015
  </td>

  <td>
    Customer not found for the given identifiers
  </td>

  <td>
    Invalid or missing costumer ID in  `toEntity`or `fromEntity` object
  </td>
</tr>
Error Code
1207
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!