Balances & StatementsBalances

Get payment and refund totals for a merchant

post/v1/transactions/merchant-summary

Returns the total of successful payments (net), the total refunded (including chargebacks), and the difference, for one merchant between fromDate and toDate (calendar dates, at most 90 days apart). For API key callers the reseller is taken from the key and the merchant must belong to it, otherwise 404. Body keys may be camelCase or snake_case.

Endpoint destination URL

https://sandbox-portal.datmanlabs.com/api/v1/transactions/merchant-summary

Authorization

ApiKeyAuth
headerapi_key<token>

Partner API key issued by Datman.

Request Parameters

Request Body

application/json
  1. body

Keys may be camelCase or snake_case (merchant_id, from_date, to_date).

merchantId*|

Merchant to summarize. A numeric string is accepted.

fromDate*string

Start calendar date (YYYY-MM-DD), inclusive.

Match^\d{4}-\d{2}-\d{2}$
toDate*string

End calendar date (YYYY-MM-DD), inclusive. At most 90 days after fromDate.

Match^\d{4}-\d{2}-\d{2}$
timezone?string

IANA timezone the dates are in. Recommended for API key callers; when omitted the dates are interpreted in UTC.

resellerId?integer

Ignored for API key callers (the key's reseller is always used).

Response parameters & Errors

Response Body

The merchant's totals. is_liable is true when the merchant is a liable account (totals then come from its own payments regardless of reseller scope). When the reseller has no queryable configuration the totals are zero and is_liable is omitted.

application/json
  1. response
data*