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}

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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": "2a0ec540-6c0f-47c4-88ba-2562b68e005b",
      "transactionType": "sample string 2",
      "amount": 1.0,
      "createDate": "2024-11-08T09:34:29.926455Z",
      "recipientId": "11446ead-6dac-4ac1-b4d8-7e174b0f0390",
      "transactionDestination": "sample string 4",
      "status": "sample string 5",
      "currencyCode": "sample string 6",
      "vendorErrorStatus": "sample string 7",
      "vendorErrorMessage": "sample string 8",
      "externalIdentifier": "sample string 9"
    },
    {
      "id": "2a0ec540-6c0f-47c4-88ba-2562b68e005b",
      "transactionType": "sample string 2",
      "amount": 1.0,
      "createDate": "2024-11-08T09:34:29.926455Z",
      "recipientId": "11446ead-6dac-4ac1-b4d8-7e174b0f0390",
      "transactionDestination": "sample string 4",
      "status": "sample string 5",
      "currencyCode": "sample string 6",
      "vendorErrorStatus": "sample string 7",
      "vendorErrorMessage": "sample string 8",
      "externalIdentifier": "sample string 9"
    }
  ],
  "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>2a0ec540-6c0f-47c4-88ba-2562b68e005b</id>
      <transactionType>sample string 2</transactionType>
      <amount>1</amount>
      <createDate>2024-11-08T09:34:29.926455+00:00</createDate>
      <recipientId>11446ead-6dac-4ac1-b4d8-7e174b0f0390</recipientId>
      <transactionDestination>sample string 4</transactionDestination>
      <status>sample string 5</status>
      <currencyCode>sample string 6</currencyCode>
      <vendorErrorStatus>sample string 7</vendorErrorStatus>
      <vendorErrorMessage>sample string 8</vendorErrorMessage>
      <externalIdentifier>sample string 9</externalIdentifier>
    </payoutTransaction>
    <payoutTransaction xmlns="">
      <id>2a0ec540-6c0f-47c4-88ba-2562b68e005b</id>
      <transactionType>sample string 2</transactionType>
      <amount>1</amount>
      <createDate>2024-11-08T09:34:29.926455+00:00</createDate>
      <recipientId>11446ead-6dac-4ac1-b4d8-7e174b0f0390</recipientId>
      <transactionDestination>sample string 4</transactionDestination>
      <status>sample string 5</status>
      <currencyCode>sample string 6</currencyCode>
      <vendorErrorStatus>sample string 7</vendorErrorStatus>
      <vendorErrorMessage>sample string 8</vendorErrorMessage>
      <externalIdentifier>sample string 9</externalIdentifier>
    </payoutTransaction>
  </payoutTransactions>
  <balance>1</balance>
</payoutTransactionSet>