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 |
|
programCurrencyName |
|
transferPoints |
|
sourceProgramMembershipNumber |
|
sourceProgramMemberId |
|
targetProgramMembershipNumber |
|
targetProgramMemberId |
|
additionalInformationorcomments |
|
Outputs
Input | Details |
---|---|
programName |
|
programCurrencyName |
|
pointsTransferred |
|
sourceProgramMemberId |
|
targetProgramMemberId |
|
sourceTransactionJournalId |
|
targetTransactionJournalId |
|
- 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 }