Skip to main content
GET
/
v1
/
deals
/
payouts
Get payouts
curl --request GET \
  --url https://api.onsleek.ai/v1/deals/payouts \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 12345,
    "totalTransactions": 100,
    "totalGmv": 5000,
    "aov": 50,
    "totalCashback": 500,
    "confirmedTransactions": 80,
    "declinedTransactions": 10,
    "pendingTransactions": 10,
    "confirmedGmv": 4000,
    "declinedGmv": 500,
    "pendingGmv": 500,
    "confirmedCashback": 400,
    "declinedCashback": 50,
    "pendingCashback": 50,
    "startDate": "2023-01-01T00:00:00.000Z",
    "endDate": "2023-01-31T23:59:59.999Z"
  }
]

Authorizations

​
Authorization
string
header
required

API key for accessing the Sleek API.

Response

200 - application/json

List of payouts.

​
id
number
required

The unique identifier for the payout.

Example:

12345

​
totalTransactions
number
required

The total number of transactions included in the payout.

Example:

100

​
totalGmv
number
required

The total order value (orderValue) of the transactions included in the payout.

Example:

5000

​
aov
number
required

The average order value of the transactions included in the payout. Calculated as totalGmv / totalTransactions.

Example:

50

​
totalCashback
number
required

The total cashback amount of the transactions included in the payout.

Example:

500

​
confirmedTransactions
number
required

The number of transactions that have been confirmed (transaction status is CONFIRMED).

Example:

80

​
declinedTransactions
number
required

The number of transactions that have been declined (transaction status is DECLINED).

Example:

10

​
pendingTransactions
number
required

The number of transactions that are still pending (transaction status is PENDING).

Example:

10

​
confirmedGmv
number
required

The total order value (orderValue) of the confirmed transactions (transaction status is CONFIRMED).

Example:

4000

​
declinedGmv
number
required

The total order value (orderValue) of the declined transactions (transaction status is DECLINED).

Example:

500

​
pendingGmv
number
required

The total order value (orderValue) of the pending transactions (transaction status is PENDING).

Example:

500

​
confirmedCashback
number
required

The total cashback amount of the confirmed transactions (transaction status is CONFIRMED).

Example:

400

​
declinedCashback
number
required

The total cashback amount of the declined transactions (transaction status is DECLINED).

Example:

50

​
pendingCashback
number
required

The total cashback amount of the pending transactions (transaction status is PENDING).

Example:

50

​
startDate
string
required

The start date of the payout period. This is the date of the first transaction included in the payout. Format: ISO 8601

Example:

"2023-01-01T00:00:00.000Z"

​
endDate
string
required

The end date of the payout period. This is the date of the last transaction included in the payout. Format: ISO 8601

Example:

"2023-01-31T23:59:59.999Z"