GET api/payouts/{id}

Get a list of payouts.

Request Information

URI Parameters

Query String:

NameDescriptionTypeAdditional information
id

ID of the payout. Optional.

string

None.

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A set of payouts.

Type: PayoutSet

NameDescriptionTypeAdditional information
payouts

Collection of Payout

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",
  "payouts": [
    {
      "id": "333073ec-d769-406b-bc86-8d2222b5bc49",
      "description": "sample string 2",
      "payoutType": "sample string 3",
      "payoutPrograms": [
        {
          "programId": "2847ecc2-ec78-46ef-9966-984102b458cb",
          "programName": "sample string 2"
        },
        {
          "programId": "2847ecc2-ec78-46ef-9966-984102b458cb",
          "programName": "sample string 2"
        }
      ]
    },
    {
      "id": "333073ec-d769-406b-bc86-8d2222b5bc49",
      "description": "sample string 2",
      "payoutType": "sample string 3",
      "payoutPrograms": [
        {
          "programId": "2847ecc2-ec78-46ef-9966-984102b458cb",
          "programName": "sample string 2"
        },
        {
          "programId": "2847ecc2-ec78-46ef-9966-984102b458cb",
          "programName": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<PayoutSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <offset>1</offset>
  <total>2</total>
  <message>sample string 3</message>
  <payouts>
    <payout>
      <id>333073ec-d769-406b-bc86-8d2222b5bc49</id>
      <description>sample string 2</description>
      <payoutType>sample string 3</payoutType>
      <payoutPrograms>
        <payoutProgram>
          <programId>2847ecc2-ec78-46ef-9966-984102b458cb</programId>
          <programName>sample string 2</programName>
        </payoutProgram>
        <payoutProgram>
          <programId>2847ecc2-ec78-46ef-9966-984102b458cb</programId>
          <programName>sample string 2</programName>
        </payoutProgram>
      </payoutPrograms>
    </payout>
    <payout>
      <id>333073ec-d769-406b-bc86-8d2222b5bc49</id>
      <description>sample string 2</description>
      <payoutType>sample string 3</payoutType>
      <payoutPrograms>
        <payoutProgram>
          <programId>2847ecc2-ec78-46ef-9966-984102b458cb</programId>
          <programName>sample string 2</programName>
        </payoutProgram>
        <payoutProgram>
          <programId>2847ecc2-ec78-46ef-9966-984102b458cb</programId>
          <programName>sample string 2</programName>
        </payoutProgram>
      </payoutPrograms>
    </payout>
  </payouts>
</PayoutSet>