search
System Status

Payouts

Payouts are an integral part of financial operations for businesses using Digital River. They represent the disbursement of funds when you receive money from Digital River or when a payment has been processed. Understanding the Payouts API allows businesses to efficiently track and manage their financial inflows and outflows according to their specific schedule, which varies depending on factors like country and industry sectors. This documentation provides detailed guidance on interacting with the Payouts resource, ensuring seamless financial transactions.

hashtag
Returns a list of payouts

get

Get all payouts.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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
chevron-right
200

200 OK

application/json
hasMorebooleanOptional

Whether or not there are more elements available after this set. If false this set represents the end of the list.

Example: true
get
/payouts

hashtag
Gets a payout by ID

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Payout ID

Responses
chevron-right
200

OK.

application/json
idstringOptional

Unique identifier for the payout

Example: 2000028600_1410_2019
createdTimestring · date-timeOptional

Time at which the payout was created

Example: 2019-04-25T20:36:00Z
payoutTimestring · date-timeOptional

Time at which the payout was issued

Example: 2019-04-25T00:00:00Z
currencystringOptional

Three-letter ISO currency code representing the payout currency.

Example: USD
amountnumber · doubleOptional

Represents the total payout amount.

Example: 1180.26
payerIdstringOptional

The ID of payer.

Example: 1410
payerNamestringOptional

The name of the payer

Example: DR globalTech, Inc.
payeeIdstringOptional

The ID of the payee.

Example: 0013900100
payeeNamestringOptional

The name of the payee.

Example: ACME, Inc.
liveModebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example: true
get
/payouts/{id}

hashtag
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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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
chevron-right
200

OK.

application/json
hasMorebooleanOptional

Whether or not there are more elements available after this set. If false this set represents the end of the list.

Example: true
get
/payouts/{id}/transactions
PreviousOrder basicsNextPlans

Last updated