GET api/payouts/pending
A collection of payouts yet to be transferred to a member. This can be filtered by the member.
Request Information
URI Parameters
Query String: memberId={memberId}&recipientId={recipientId}&includeIneligible={includeIneligible}
Name | Description | Type | Additional information |
---|---|---|---|
memberId |
(deprecated) The unique ID of the member to whom the amount is owed. Opitonal. |
string |
None. |
recipientId |
The unique ID of the recpient to whom the amount is owed. Optional. |
string |
None. |
includeIneligible |
Includes payouts for ineligibile rewards based on eligiblity date dates in the future. Optional. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
[HTTP Status 200 - OK] A set of pending payouts
Type: PayoutPendingSet
Name | Description | Type | Additional information |
---|---|---|---|
payoutsPending |
A list of payoutPending objects. |
Collection of PayoutPending |
None. |
offset |
Starting index (0 based) of the elements in the set. |
integer |
None. |
total |
Total number of elements in the set. |
integer |
None. |
message |
The message provides more information about the results of the client's request. Review this field for error information. |
string |
None. |
Response Formats
application/json, text/json
{ "offset": 1, "total": 2, "message": "sample string 3", "payoutsPending": [ { "payoutId": "b31cdc90-26a2-4021-b9cf-709d8796772f", "Description": "sample string 2", "rewardCount": 3, "amount": 4.0, "rewardsList": "sample string 5", "programId": "8683bd8b-5810-4216-a41b-16ff386cce66", "programName": "sample string 7", "memberId": "37380b7c-1494-4ded-b34e-6f7759c80a54", "memberName": "sample string 9", "recipientId": "79e12ec5-b1ce-4dfc-a31d-b27d6cf00cd3", "RecipientName": "sample string 11", "RecipientType": "sample string 12" }, { "payoutId": "b31cdc90-26a2-4021-b9cf-709d8796772f", "Description": "sample string 2", "rewardCount": 3, "amount": 4.0, "rewardsList": "sample string 5", "programId": "8683bd8b-5810-4216-a41b-16ff386cce66", "programName": "sample string 7", "memberId": "37380b7c-1494-4ded-b34e-6f7759c80a54", "memberName": "sample string 9", "recipientId": "79e12ec5-b1ce-4dfc-a31d-b27d6cf00cd3", "RecipientName": "sample string 11", "RecipientType": "sample string 12" } ] }
application/xml, text/xml
<payoutsPendingSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response"> <offset xmlns="">1</offset> <total xmlns="">2</total> <message xmlns="">sample string 3</message> <payoutsPending> <PayoutPending> <payoutId>b31cdc90-26a2-4021-b9cf-709d8796772f</payoutId> <Description>sample string 2</Description> <rewardCount>3</rewardCount> <amount>4</amount> <rewardsList>sample string 5</rewardsList> <programId>8683bd8b-5810-4216-a41b-16ff386cce66</programId> <programName>sample string 7</programName> <memberId>37380b7c-1494-4ded-b34e-6f7759c80a54</memberId> <memberName>sample string 9</memberName> <recipientId>79e12ec5-b1ce-4dfc-a31d-b27d6cf00cd3</recipientId> <RecipientName>sample string 11</RecipientName> <RecipientType>sample string 12</RecipientType> </PayoutPending> <PayoutPending> <payoutId>b31cdc90-26a2-4021-b9cf-709d8796772f</payoutId> <Description>sample string 2</Description> <rewardCount>3</rewardCount> <amount>4</amount> <rewardsList>sample string 5</rewardsList> <programId>8683bd8b-5810-4216-a41b-16ff386cce66</programId> <programName>sample string 7</programName> <memberId>37380b7c-1494-4ded-b34e-6f7759c80a54</memberId> <memberName>sample string 9</memberName> <recipientId>79e12ec5-b1ce-4dfc-a31d-b27d6cf00cd3</recipientId> <RecipientName>sample string 11</RecipientName> <RecipientType>sample string 12</RecipientType> </PayoutPending> </payoutsPending> </payoutsPendingSet>