List transactions - Fingo Pay

Authorizations

Authorization

string

header

required

Use your API key as a Bearer token. Example: Authorization: Bearer sk_live_...

Query Parameters

startDate

string<date>

required

Start date for the query range (ISO 8601 format, e.g., 2025-01-01).

endDate

string<date>

required

End date for the query range (ISO 8601 format, e.g., 2025-01-31).

type

enum<string>

Filter by transaction type.

Available options:

charge,

transfer,

payment,

settlement,

airtime,

reversal,

bank_deposit,

bank_withdrawal

status

enum<string>

Filter by transaction status.

Available options:

pending,

completed,

failed,

settled,

initiated,

rejected

accountType

enum<string>

Filter by account type.

Available options:

collections,

payouts

accountNo

string

Filter by specific account number.

customerId

string

Filter by customer ID.

shortcode

string

[Enterprise] Filter transactions by dedicated shortcode number. Returns only transactions routed through the specified shortcode. The shortcode must belong to your organization.

limit

integer

default:10000

Maximum number of results to return.

Required range: 1 <= x <= 10000

Response

Transactions fetched successfully

status

string

required

Example:

"success"

message

string

required

Example:

"Transactions fetched"

data

object

required

Hide child attributes

data.items

object[]

required

Hide child attributes

data.items.publicId

string

required

Fingo transaction ID

Example:

"txn_01j7b6f9p5y9h"

data.items.status

enum<string>

required

Available options:

pending,

completed,

failed,

settled,

initiated,

rejected

Example:

"completed"

data.items.currency

string

required

Example:

"KES"

data.items.accountType

enum<string>

required

Available options:

collections,

payouts

Example:

"collections"

data.items.type

enum<string>

required

Available options:

charge,

transfer,

payment,

settlement,

airtime,

reversal,

bank_deposit,

bank_withdrawal

Example:

"charge"

data.items.paymentMethod

enum<string>

required

Available options:

mobile_money,

bank

Example:

"mobile_money"

data.items.processor

enum<string>

required

Available options:

mpesa,

choicebank

Example:

"mpesa"

data.items.createdAt

integer

required

Unix timestamp in milliseconds

Example:

1723717200000

data.items.updatedAt

integer

required

Unix timestamp in milliseconds

Example:

1723717320000

data.items.merchantTransactionId

string | null

Your merchant reference

Example:

"mtx_123"

data.items.message

string | null

Example:

"Payment completed successfully"

data.items.amount

integer | null

Transaction amount in smallest unit

Example:

10000

data.items.chargedAmount

integer | null

Amount charged to customer

Example:

10000

data.items.processorReference

string | null

Reference from payment processor

Example:

"ODI31ABC123"

data.items.phoneNumber

string | null

Example:

"+254712345678"

data.items.narration

string | null

Example:

"Invoice #1234"

data.items.customerId

string | null

Internal customer ID

data.items.customer

object

Customer details if available

data.items.fees

integer | null

Total fees charged (in smallest unit)

Example:

100

data.items.metadata

object

Metadata echoed from the original request. Can include enterprise keys such as subMerchantDetails.

data.items.subMerchantId

string | null

Organization-scoped sub-merchant identifier supplied in the request.

data.items.subMerchantDetails

object

Optional sub-merchant enrichment details when available.

Hide child attributes

data.items.subMerchantDetails.name

string

Display/trading name for the sub-merchant.

Example:

"Nairobi West Branch"

data.items.subMerchantDetails.legalName

string

Registered legal name for the sub-merchant.

Example:

"Nairobi West Branch Limited"

data.items.subMerchantDetails.businessType

string

Optional business entity type.

Example:

"Limited Liability Company"

data.items.subMerchantDetails.email

string<email>

Optional sub-merchant contact email.

data.items.subMerchantDetails.phoneNumber

string

Optional sub-merchant contact phone number.

Example:

"+254712345678"

data.items.subMerchantDetails.businessCertNo

string

Optional business registration certificate number.

data.items.subMerchantDetails.taxId

string

Optional tax identifier (for example KRA PIN).

data.items.subMerchantDetails.economicSector

string

Optional economic sector reference.

data.items.subMerchantDetails.riskLevel

enum<string>

Optional risk tier used for reconciliation and post-transaction controls.

Available options:

low,

medium,

high

data.count

integer

required

Number of transactions returned

Example:

150

data.startDate

string<date>

required

Example:

"2025-01-01"

data.endDate

string<date>

required

Example:

"2025-01-31"