Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
Transaction

Returns total amount of transactions

Use this endpoint to retrieve total amount of checkout, payout or refund transactions. Transactions can be filtered using date, customer Id or phone number

get/transactions/amount

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'

type of transaction to consider

customer_idstring uuid

Returns total amount of transaction for a given customer. If provided, query parameter type must be passed also

customer_phonestring

Returns total amount of transaction for a given phone number. If provided, query parameter type must be passed also

device_idstring

Returns list of transaction for a given device or terminal. If provided, query parameter type must be passed also

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 amount.

amountinteger

total Amount for a transaction or a collection of transactions.

currencystring

The currency associated to the amount.

Example response

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