Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
Transaction

Net available and pending Revenues

Returns total amount of payment minus transfer and merchant fees, pending amount and pending fees for a given merchant

get/transactions/net-revenues

Query parameters

merchant_idstring uuid required

Unique identifier of the merchant

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

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 available and pending revenues.

amountinteger

net Revenues

pendingAmountinteger

correspond to pending net Revenues

currencystring

The currency associated to the amount.

timestampstring date-time

The time and date that the transaction was recorded in our system.

Example response

{
  "amount": 10000,
  "pendingAmount": 10000,
  "currency": "XOF",
  "timestamp": "2022-06-20T17:17:11Z"
}