Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
Transaction

search transactions by customer name or customer phone

Use this endpoint to search the list of checkout, payout and refund transactions. using customer name or phone.

get/transactions/search

Query parameters

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

type of transaction to retrieve. If not provided, all transactions are returned

customer_namestring

Returns list of transaction for a given customer.

customer_phonestring

Returns list of transaction for a given phone number.

payment_referencestring

Returns list of transactions with this payment reference.

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

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'wave_money' | 'orange_money' | 'maxit' | 'mtn_money' | 'free_money' | 'moov' | 'mobicash' | 'togocell' | 'bictorys' | 'card' 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.

transactionFeeAmountHTnumber double

Transaction fee amount without tax.

transactionFeeAmountTaxnumber double

Transaction fee tax. The value is zero if tax is not applicable

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

deviceIdstring

The identifier of the device used to make the payment

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": 25,
    "transactionFeeAmountHT": 25,
    "currency": "XOF",
    "paymentReference": "33e1c83b-7cb0-437b-bc50-a7a58e5660ad",
    "merchantReference": "33e1c83b-7cb0-437b-bc50-a7a58e5660ad",
    "orderType": "invoice",
    "orderId": "14e1c83b-7cb0-437b-bc50-a7a58e5660ad",
    "deviceId": "SN-4562345",
    "originIp": "192.0.0.1",
    "timestamp": "2022-06-20T17:17:11Z"
  }
]