GET api/payouts/transactions

A collection of transactions that represent payouts transferred to participants of a referral program. This can be filtered by recipient or transactionId.

Request Information

URI Parameters

Query String: recipientId={recipientId}&transactionId={transactionId}

NameDescriptionTypeAdditional information
recipientId

The unique ID of the recipient of the payout transaction. Optional

string

None.

transactionId

The unique ID of the payout transaction. Optional.

string

None.

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A set of transactions

Type: PayoutTransactionSet

NameDescriptionTypeAdditional information
payoutTransactions

A list of payout transactions.

Collection of PayoutTransaction

None.

balance

The balance left in the account to fulfill pending payouts.

decimal number

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": 2,
  "total": 3,
  "message": "sample string 4",
  "payoutTransactions": [
    {
      "id": "32e86e23-f7d3-4038-9264-fb2af1107cc9",
      "transactionType": "sample string 2",
      "amount": 1.0,
      "createDate": "2018-04-22T04:25:21.0052729Z",
      "recipientId": "5b5999e9-fb73-4c6e-9738-fe1ebe92a753",
      "transactionDestination": "sample string 4",
      "status": "sample string 5"
    },
    {
      "id": "32e86e23-f7d3-4038-9264-fb2af1107cc9",
      "transactionType": "sample string 2",
      "amount": 1.0,
      "createDate": "2018-04-22T04:25:21.0052729Z",
      "recipientId": "5b5999e9-fb73-4c6e-9738-fe1ebe92a753",
      "transactionDestination": "sample string 4",
      "status": "sample string 5"
    }
  ],
  "balance": 1.0
}

application/xml, text/xml

Sample:
<payoutTransactionSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response">
  <offset xmlns="">2</offset>
  <total xmlns="">3</total>
  <message xmlns="">sample string 4</message>
  <payoutTransactions>
    <payoutTransaction xmlns="">
      <id>32e86e23-f7d3-4038-9264-fb2af1107cc9</id>
      <transactionType>sample string 2</transactionType>
      <amount>1</amount>
      <createDate>2018-04-22T00:25:21.0052729-04:00</createDate>
      <recipientId>5b5999e9-fb73-4c6e-9738-fe1ebe92a753</recipientId>
      <transactionDestination>sample string 4</transactionDestination>
      <status>sample string 5</status>
    </payoutTransaction>
    <payoutTransaction xmlns="">
      <id>32e86e23-f7d3-4038-9264-fb2af1107cc9</id>
      <transactionType>sample string 2</transactionType>
      <amount>1</amount>
      <createDate>2018-04-22T00:25:21.0052729-04:00</createDate>
      <recipientId>5b5999e9-fb73-4c6e-9738-fe1ebe92a753</recipientId>
      <transactionDestination>sample string 4</transactionDestination>
      <status>sample string 5</status>
    </payoutTransaction>
  </payoutTransactions>
  <balance>1</balance>
</payoutTransactionSet>