---
title: "search transactions by customer name or customer phone"
method: GET
path: "/transactions/search"
tags: ["Transaction"]
---

# search transactions by customer name or customer phone

`GET /transactions/search`

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

## Query parameters

- `type` 'checkout' | 'payout' | 'refund'
- `customer_name` string
- `customer_phone` string
- `payment_reference` string

## Headers

- `X-Amzn-Trace-Id` string

## Response `200`

List of transactions.

- TransactionObjectResponse[]
  - `id` string, uuid — Unique identifier of the transaction
  - `merchantId` string, uuid — Unique Merchant Identifier
  - `type` 'payment' | 'transfer' | 'refund' | 'settlement' — type of transaction
  - `customerId` string, uuid — Identifier of the customer who paid the transaction
  - `customerObject` CustomerObject
    - `id` string, uuid — unique uuid of the customer
    - `name` string — customer's full name
    - `phone` string — customer's mobile phone number.
    - `email` string — the email of the customer
    - `address` string — Full street address, which MAY include house number, street name, Post Office Box, etc
    - `city` string — City or locality component.
    - `postalCode` string — Zip code or postal code component.
    - `country` string, required — ISO3166-1 alpha-2 two letter, uppercase.
    - `locale` string — User locale, language is lower case. Country in upper case
    - `createdAt` string — The date time that record was created in our system.
    - `updatedAt` string — The date time that record was updated in our system.
  - `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
  - `paymentMeans` string — means of transaction
  - `paymentChannel` 'Terminal' | 'Online' — Channel used to make the payment
  - `amount` number, double — This is the amount received or paid by the merchant, net of fees.
  - `merchantFees` number, double — The fee paid by the merchant for receiving the payment.
  - `customerFees` number, double — The fee paid by the customer for receiving the payment.
  - `transactionFeeAmountHT` number, double — Transaction fee amount without tax.
  - `transactionFeeAmountTax` number, double — Transaction fee tax. The value is zero if tax is not applicable
  - `currency` string — The currency associated to the amount. If you don't specify a value, we'll assume 'XOF'
  - `paymentReference` string — payment Reference
  - `merchantReference` string — 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.
  - `orderId` string — 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
  - `deviceId` string — The identifier of the device used to make the payment
  - `originIp` string — IP address of the device that have sent the request
  - `timestamp` string, 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

## Other responses

- `400` — Bad Request
- `401` — The caller is unauthenticated
- `403` — Access rights not sufficient
- `404` — Card not found
- `500` — Internal Server Error.

---

[API](https://skmtc.dev/bictorys/apis/pay.md) · [All operations](https://skmtc.dev/bictorys/apis/pay/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bictorys/pay/revisions/b85cce14340b/schema)