Transfer Points

Transfers points from a source loyalty program member to a target loyalty program member, or to a group that the member is a part of.

This action is available in API version 64.0 and later for users with Loyalty Management license.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/transferPoints
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
programName
Type
String
Description
Required. The name of the loyalty program that the source and target members are a part of.
programCurrencyName
Type
ID
Description
The name of the non-qualifying currency for which points are transferred.
transferPoints
Type
Integer
Description
The number of points that are transferred.
sourceProgramMembershipNumber
Type
Integer
Description
The membership number of the loyalty program member from whom the points are transferred. Either the membership number or the member ID is mandatory.
sourceProgramMemberId
Type
ID
Description
The ID of the loyalty program member from whom the points are transferred. Either the membership number or the member ID is mandatory.
targetProgramMembershipNumber
Type
Integer
Description
The membership number of the loyalty program member to whom the points are transferred. Either the membership number or the member ID is mandatory.
targetProgramMemberId
Type
ID
Description
The ID of the loyalty program member to whom the points are transferred. Either the membership number or the member ID is mandatory.
additionalInformationorcomments
Type
ID
Description
The additional information about the transfer of points.

Outputs

Input Details
programName
Type
String
Description
Required. The name of the loyalty program that the source and target members are a part of.
programCurrencyName
Type
ID
Description
The name of the non-qualifying currency for which points are transferred.
pointsTransferred
Type
Integer
Description
The number of points that are transferred.
sourceProgramMemberId
Type
ID
Description
The ID of the loyalty program member from whom the points are transferred.
targetProgramMemberId
Type
ID
Description
The ID of the loyalty program member to whom the points are transferred.
sourceTransactionJournalId
Type
ID
Description
The ID of the transaction journal that debited points from the source loyalty program member.
targetTransactionJournalId
Type
ID
Description
The ID of the transaction journal that credited points to the target loyalty program member.
Sample Request
{
"inputs": [
{
"programName": "NTORules",
"sourceProgramMembershipNumber": "N01",
"targetProgramMembershipNumber": "N02",
"programCurrencyName": "NQP Fixed Negative Trace",
"transferPoints": 5,
"notes": "Tried Transfer Points testing"
}
]
}
Sample Response
{
"actionName":"transferPoints",
"errors":null,"invocationId":null,
"isSuccess":true,"outcome":null,
"outputValues":{
"targetTransactionJournalId":"0lVLT0000001ATa",
"programCurrencyName":"NQPFixed",
"programName":"Program001",
"pointsTransferred":10,
"sourceProgramMemberId":"0lMLT0000000OtZ",
"sourceTransactionJournalId":"0lVLT0000001ATZ",
"targetProgramMemberId":"0lMLT0000000OvB"},
"sortOrder":-1,"version":1
}