Transfer Points | Loyalty Management Developer Guide

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.
additionalInformation	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

1{
2"inputs": [
3{
4"programName": "NTORules",
5"sourceProgramMembershipNumber": "N01",
6"targetProgramMembershipNumber": "N02",
7"programCurrencyName": "NQP Fixed Negative Trace",
8"transferPoints": 5,
9"additionalInformation": "Tried Transfer Points testing"
10}
11]
12}

Sample Response

1{
2"actionName":"transferPoints",
3"errors":null,"invocationId":null,
4"isSuccess":true,"outcome":null,
5"outputValues":{
6"targetTransactionJournalId":"0lVLT0000001ATa",
7"programCurrencyName":"NQPFixed",
8"programName":"Program001",
9"pointsTransferred":10,
10"sourceProgramMemberId":"0lMLT0000000OtZ",
11"sourceTransactionJournalId":"0lVLT0000001ATZ",
12"targetProgramMemberId":"0lMLT0000000OvB"},
13"sortOrder":-1,"version":1
14}