Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
Transaction

Returns total fees of transactions paid by the merchant

Use this endpoint to retrieve total amount of checkout, payout or refund transactions fees.

get/transactions/merchant-fees

Query parameters

start_datestring date-time
Example:2023-05-22T00:00:00+00

Optional. Query transactions starting from this date, if not provided, 2023-09-01T00:00:00+00 is used. The date format is ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS). The timezone is UTC and precision is in seconds

end_datestring date-time
Example:2023-05-22T11:53:14+00

Query transactions from start_date until this date time, if omitted, current date-time is used. The date format is ISO 8601 (YYYY-mm-dd HH:mm:ss,SSSS). The timezone is UTC and precision is in seconds. If this filter is set, filters customer_id and phone are ignored

type'checkout' | 'payout' | 'refund' required

type of transaction to consider

Headers

X-Amzn-Trace-Idstring

The parameter Identifies this HTTP request across all services. It helps to diagnostic request errors. The parameter is added automatically by the API gateway

Response

total fees.

amountinteger

total Amount for a transaction or a collection of transactions.

currencystring

The currency associated to the amount.

Example response

{
  "amount": 45000,
  "currency": "XOF"
}