Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
Transaction

Returns list of settlements

Use this endpoint to retrieve the list of settlements. Transactions can be filtered using date

get/transactions

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.

page_offsetinteger

pagination offset, default is 0.

page_sizeinteger

Page size. default value is 20

Response

List of transactions.

idstring uuid

Unique identifier of the transaction

merchantIdstring uuid

Unique Merchant Identifier

type'payment' | 'transfer' | 'refund' | 'settlement'

type of transaction

customerIdstring uuid

Identifier of the customer who paid the transaction

pspName'card' | 'orange_money' | 'wave_money' | 'mtn_money' | 'move_money' | 'free_money' | 'visa_card' | 'mastercard_card' | 'bictorys' required

The PSP, mobile money or card, used for this transaction

paymentMeansstring

means of transaction

paymentChannel'Terminal' | 'Online'

Channel used to make the payment

amountnumber double

This is the amount received or paid by the merchant, net of fees.

merchantFeesnumber double

The fee paid by the merchant for receiving the payment.

customerFeesnumber double

The fee paid by the customer for receiving the payment.

currencystring

The currency associated to the amount. If you don't specify a value, we'll assume 'XOF'

paymentReferencestring

payment Reference

merchantReferencestring

reference passed by client in the request

orderType'flat' | 'order' | 'invoice' | 'paymentlink'

Reference to the type of the payment, invoice, paymentlink, order, flat means the merchant did not create an order or an invoice or a paymentlink prior to call charges API.

orderIdstring

unique Id of the order. invoiceId, orderId or paymentlinkId. This value is empty if orderType equals to flat

status'succeeded' | 'failed' | 'cancelled' | 'pending' | 'processing' | 'reversed' | 'authorized' required

status of the transaction

originIpstring

IP address of the device that have sent the request

timestampstring required

The time and date that the the transaction was recorded in our system. Note that this doesn't describe when payments were executed, only when they were submitted

Example response

[
  {
    "id": "33e1c83b-7cb0-437b-bc50-a7a58e5660ad",
    "merchantId": "d2d2053b-638d-4133-957e-3caf63e6b79c",
    "customerId": "33e1c83b-7cb0-437b-bc50-a7a58e5660ad",
    "customerObject": {
      "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
      "name": "John Dao",
      "email": "john.dao@example.com",
      "address": "23, avenue de la liberté",
      "city": "Dakar",
      "country": "SN",
      "locale": "fr-FR",
      "createdAt": "2022-06-20T17:17:11Z",
      "updatedAt": "2022-06-20T17:17:11Z"
    },
    "pspName": "card",
    "paymentMeans": "+221 *** ** 09",
    "paymentChannel": "Terminal",
    "amount": 100,
    "merchantFees": 2.5,
    "customerFees": 1,
    "currency": "XOF",
    "paymentReference": "33e1c83b-7cb0-437b-bc50-a7a58e5660ad",
    "merchantReference": "33e1c83b-7cb0-437b-bc50-a7a58e5660ad",
    "orderType": "invoice",
    "orderId": "14e1c83b-7cb0-437b-bc50-a7a58e5660ad",
    "originIp": "192.0.0.1",
    "timestamp": "2022-06-20T17:17:11Z"
  }
]
All 82 operations