Get payout statistics

get/v1/merchants/{merchantId}/payout-stats

Returns the merchant's provider payout transactions grouped by status, with the number of payouts and the total amount (in major currency units) for each status. This covers all time. Payout batches are not counted. Returns an empty list when the merchant has no payout transactions. The merchant must belong to your reseller, otherwise 404.

Endpoint destination URL

https://sandbox-portal.datmanlabs.com/api/v1/merchants/{merchantId}/payout-stats

Authorization

ApiKeyAuth

headerapi_key<token>

Partner API key issued by Datman.

Request Parameters

RequiredOptional

Path Parameters

merchantId*integer

Numeric merchant id. Must be a positive integer belonging to your reseller.

Range1 <= value

Response parameters & Errors

Response Body

Payout counts and totals by status.

application/json

response

data*array<>

Response parameters & Errors ↓

Request

GET

/v1/merchants/{merchantId}/payout-stats

curl -X GET 'https://sandbox-portal.datmanlabs.com/api/v1/merchants/123456/payout-stats'

JSON Response

{  "data": [    {      "status": "SENT",      "order_count": 42,      "total_amount": 18250.5    },    {      "status": "FAILED",      "order_count": 1,      "total_amount": 310    }  ]}