System Status

Payouts

The Payouts resource lets you list all payouts, retrieve an individual payout, and list the payout transactions for a payout. Payouts are made on varying schedules, depending on your country and industry.

Returns a list of payouts

get

Get all payouts.

Authorizations
Query parameters
endingBeforestringOptional

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstringOptional

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

idsstring[]Optional

Only return objects with these IDs.

limitinteger · min: 1 · max: 5000Optional

A limit on the number of objects returned. Limit can range between 1 and 5000, and the default is 10.

payerIdstringOptional

Only return payouts with this payer identifier

payerNamestringOptional

Only return payouts with this payer name

payeeIdstringOptional

Only return payouts with this payee identifier

payeeNamestringOptional

Only return payouts with this payee name

currencystringOptional

Only return payouts in the given currency

Responses
200
200 OK
application/json
get
GET /payouts HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "2000028600_1410_2019",
      "createdTime": "2025-07-01T01:56:03.644Z",
      "payoutTime": "2025-07-01T01:56:03.644Z",
      "currency": "USD",
      "amount": 1180.26,
      "payerId": "1410",
      "payerName": "DR globalTech, Inc.",
      "payeeId": "0013900100",
      "payeeName": "ACME, Inc.",
      "liveMode": true
    }
  ]
}

Gets a payout by ID.

get

Retrieves the details of a payout. Supply the unique identifier of the payout.

Authorizations
Path parameters
idstringRequired

Payout ID

Responses
200
OK.
application/json
get
GET /payouts/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "2000028600_1410_2019",
  "createdTime": "2025-07-01T01:56:03.644Z",
  "payoutTime": "2025-07-01T01:56:03.644Z",
  "currency": "USD",
  "amount": 1180.26,
  "payerId": "1410",
  "payerName": "DR globalTech, Inc.",
  "payeeId": "0013900100",
  "payeeName": "ACME, Inc.",
  "liveMode": true
}

Lists the payout transactions for a payout.

get

Retrieves the details of the payout transactions for a payout. Supply the unique identifier of the payout.

Authorizations
Path parameters
idstringRequired

Payout ID

Query parameters
endingBeforestringOptional

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstringOptional

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 5000Optional

A limit on the number of objects returned. Limit can range between 1 and 5000, and the default is 10.

Responses
200
OK.
application/json
get
GET /payouts/{id}/transactions HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "8100000400_1410_2019",
      "createdTime": "2025-07-01T01:56:03.644Z",
      "currency": "USD",
      "amount": 1180.26,
      "payoutId": "2000028600_1410_2019",
      "description": "Sales for Period Ended 04-25-2020",
      "type": "sales_summary",
      "liveMode": true
    }
  ]
}
PreviousOrdersNextPlans

Last updated