Error
A valid request URL is required to generate request examples{
"success": true,
"message": "Transactions retrieved successfully",
"data": [
{
"id": "<string>",
"referenceId": "<string>",
"paymentLinkId": "<string>",
"customer": {
"email": "you@example.com",
"phone": "+254712345678",
"name": "John Doe",
"address": "<string>"
},
"paymentMethod": "mobile_money",
"currency": "<string>",
"amount": 123,
"transactionAmount": 123,
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"transactionCost": 123,
"packageId": "<string>",
"packageName": "<string>",
"providerReference": "<string>",
"transactionError": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"deposit": {
"id": "<string>",
"referenceId": "<string>",
"referenceNumber": 123,
"amount": 123,
"transactionAmount": 123,
"transactionCost": 123,
"status": "PENDING",
"provider": "<string>",
"providerReference": "<string>",
"providerResponse": {},
"callbackResponse": {},
"callbackPayload": {},
"callbackStatusCode": 123,
"transactionError": "<string>",
"retries": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"redirectUrl": "<string>",
"requiresAction": true,
"redirectMode": "top",
"type": "<string>",
"walletAddress": "<string>",
"network": "<string>",
"token": "<string>"
}
],
"total": 1,
"limit": 20,
"offset": 0
}{
"success": false,
"message": "Invalid API Key",
"data": {}
}Payment Links
Get Payment Link Transactions
GET
/
api
/
v3
/
payment-links
/
{id}
/
transactions
Error
A valid request URL is required to generate request examples{
"success": true,
"message": "Transactions retrieved successfully",
"data": [
{
"id": "<string>",
"referenceId": "<string>",
"paymentLinkId": "<string>",
"customer": {
"email": "you@example.com",
"phone": "+254712345678",
"name": "John Doe",
"address": "<string>"
},
"paymentMethod": "mobile_money",
"currency": "<string>",
"amount": 123,
"transactionAmount": 123,
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"transactionCost": 123,
"packageId": "<string>",
"packageName": "<string>",
"providerReference": "<string>",
"transactionError": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"deposit": {
"id": "<string>",
"referenceId": "<string>",
"referenceNumber": 123,
"amount": 123,
"transactionAmount": 123,
"transactionCost": 123,
"status": "PENDING",
"provider": "<string>",
"providerReference": "<string>",
"providerResponse": {},
"callbackResponse": {},
"callbackPayload": {},
"callbackStatusCode": 123,
"transactionError": "<string>",
"retries": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"redirectUrl": "<string>",
"requiresAction": true,
"redirectMode": "top",
"type": "<string>",
"walletAddress": "<string>",
"network": "<string>",
"token": "<string>"
}
],
"total": 1,
"limit": 20,
"offset": 0
}{
"success": false,
"message": "Invalid API Key",
"data": {}
}Get the transactions collected through a specific payment link, filterable by status and payment method.
For card and crypto payments, check
requiresAction/redirectUrl/redirectMode — some providers need an additional 3DS redirect before the payment completes. redirectMode tells you whether that redirect can be framed in-page (iframe) or must open the top-level window (top).Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Available options:
pending, processing, successful, failed, cancelled, expired Available options:
mobile_money, bank, card, crypto Search by customer email/phone/name