Getting a payout by ID

Learn how to get a payout by identifier.

To retrieve specific payout details in the Digital River API, you use the "Get Payout by ID" feature. You can access comprehensive information about a particular payout by sending a GET /payouts request with a unique payout identifier. This feature is crucial for tracking and managing payouts within your system.

Setting payout path parameters

The following table lists the required parameters you can provide in a get payout by ID request.

Parameter	Required/Optional	Description
id	Required	Unique payout identifier.

Get payout by ID request and response example

To obtain details about a specific payout, you can send a GET /payouts request with the payout's unique identifier. The following example demonstrates how to formulate a request to fetch a payout by its ID and the expected response structure containing the payout details.

To retrieve details of a payout, you must supply the unique identifier of the payout:

Request header example

GET /payouts​/2000028600_1410_2019

A 200 OK response returns the Payout object.

Payout object

{
  "id": "2000028600_1410_2019",
  "createdTime": "2019-04-25T20:36:00Z",
  "updatedTime": "2019-04-26T20:36:00Z",
  "payoutTime": "2019-04-25T00:00:00Z",
  "currency": "USD",
  "amount": 1180.26,
  "payerId": "1410",
  "payerName": "DR globalTech, Inc.",
  "payeeId": "0013900100",
  "payeeName": "ACME, Inc.",
  "liveMode": true
}