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}

NameDescriptionTypeAdditional 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

NameDescriptionTypeAdditional 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

Sample:
{
  "offset": 1,
  "total": 2,
  "message": "sample string 3",
  "payoutsPending": [
    {
      "payoutId": "67ce8493-79a8-4502-9a08-f2461783a2f1",
      "Description": "sample string 2",
      "rewardCount": 3,
      "amount": 4.0,
      "rewardsList": "sample string 5",
      "programId": "0045fdd1-1e51-49d4-af19-c0dc6480e2e2",
      "programName": "sample string 7",
      "memberId": "82b8af31-eaea-491c-aba7-c60bb7ea45b7",
      "memberName": "sample string 9",
      "recipientId": "02dd6133-7e9e-48d9-9df0-23bafd07ca27",
      "RecipientName": "sample string 11",
      "RecipientType": "sample string 12"
    },
    {
      "payoutId": "67ce8493-79a8-4502-9a08-f2461783a2f1",
      "Description": "sample string 2",
      "rewardCount": 3,
      "amount": 4.0,
      "rewardsList": "sample string 5",
      "programId": "0045fdd1-1e51-49d4-af19-c0dc6480e2e2",
      "programName": "sample string 7",
      "memberId": "82b8af31-eaea-491c-aba7-c60bb7ea45b7",
      "memberName": "sample string 9",
      "recipientId": "02dd6133-7e9e-48d9-9df0-23bafd07ca27",
      "RecipientName": "sample string 11",
      "RecipientType": "sample string 12"
    }
  ]
}

application/xml, text/xml

Sample:
<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>67ce8493-79a8-4502-9a08-f2461783a2f1</payoutId>
      <Description>sample string 2</Description>
      <rewardCount>3</rewardCount>
      <amount>4</amount>
      <rewardsList>sample string 5</rewardsList>
      <programId>0045fdd1-1e51-49d4-af19-c0dc6480e2e2</programId>
      <programName>sample string 7</programName>
      <memberId>82b8af31-eaea-491c-aba7-c60bb7ea45b7</memberId>
      <memberName>sample string 9</memberName>
      <recipientId>02dd6133-7e9e-48d9-9df0-23bafd07ca27</recipientId>
      <RecipientName>sample string 11</RecipientName>
      <RecipientType>sample string 12</RecipientType>
    </PayoutPending>
    <PayoutPending>
      <payoutId>67ce8493-79a8-4502-9a08-f2461783a2f1</payoutId>
      <Description>sample string 2</Description>
      <rewardCount>3</rewardCount>
      <amount>4</amount>
      <rewardsList>sample string 5</rewardsList>
      <programId>0045fdd1-1e51-49d4-af19-c0dc6480e2e2</programId>
      <programName>sample string 7</programName>
      <memberId>82b8af31-eaea-491c-aba7-c60bb7ea45b7</memberId>
      <memberName>sample string 9</memberName>
      <recipientId>02dd6133-7e9e-48d9-9df0-23bafd07ca27</recipientId>
      <RecipientName>sample string 11</RecipientName>
      <RecipientType>sample string 12</RecipientType>
    </PayoutPending>
  </payoutsPending>
</payoutsPendingSet>