POST api/payouts/transactions

Payout pending rewards. Returns transactions of issued rewards.

Request Information

URI Parameters

Query String: overrideIneligible={overrideIneligible}

Name	Description	Type	Additional information
overrideIneligible	Allows you to override eligiblity date rules. Payout reward with eligibility dates in the future.	boolean	Default value is False

Body Parameters

Data needed for issuing a reward. Required.

Type: IssuePayoutTransaction

Name	Description	Type	Additional information
memberId	(deprecated) The unique ID of the member to whom the payouts will be issued. Optional.	string	None.
recipientId	The unique ID of the recipient to whom the payouts will be issued. Optional.	string	None.
payoutId	The unique ID of the payout type for which all pending amounts will be issued.	string	Required
note	A message to send to the recipient of the issued payout. Optional.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "memberId": "sample string 1",
  "recipientId": "sample string 2",
  "payoutId": "sample string 3",
  "note": "sample string 4"
}

application/xml, text/xml

Sample:

<issuePayoutTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <memberId>sample string 1</memberId>
  <recipientId>sample string 2</recipientId>
  <payoutId>sample string 3</payoutId>
  <note>sample string 4</note>
</issuePayoutTransaction>

Response Information

Resource Description

[HTTP Status 200 - OK] A set of payout transactions.

Type: HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.