Get transaction by ID or merchantTransactionId

GET

transaction

JavaScript

import FingoPay from '@fingoafrica/fingo-pay';

const client = new FingoPay({
  apiKey: process.env['FINGO_PAY_API_KEY'], // This is the default and can be omitted
});

const transaction = await client.transactions.get();

console.log(transaction.data);

{
  "status": "success",
  "message": "Transaction fetched",
  "data": {
    "publicId": "txn_01j7b6f9p5y9h",
    "status": "completed",
    "currency": "KES",
    "accountType": "collections",
    "type": "charge",
    "paymentMethod": "mobile_money",
    "processor": "mpesa",
    "createdAt": 1723717200000,
    "updatedAt": 1723717320000,
    "merchantTransactionId": "mtx_123",
    "message": "Payment completed successfully",
    "amount": 10000,
    "chargedAmount": 10000,
    "processorReference": "ODI31ABC123",
    "phoneNumber": "+254712345678",
    "narration": "Invoice #1234",
    "customerId": "<string>",
    "customer": {},
    "fees": 100
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

transactionId

string

Fingo transaction ID (e.g., txn_01j7b6f9p5y9h).

merchantTransactionId

string

Your merchant transaction ID.

Response

Transaction fetched successfully

status

string

Example:

"success"

message

string

Example:

"Transaction fetched"

data

object

Transaction object returned in API responses.

Show child attributes

data.publicId

string

required

Fingo transaction ID

Example:

"txn_01j7b6f9p5y9h"

data.status

enum<string>

required

Available options:

pending,

completed,

failed,

settled,

initiated,

rejected

Example:

"completed"

data.currency

string

required

Example:

"KES"

data.accountType

enum<string>

required

Available options:

collections,

payouts

Example:

"collections"

data.type

enum<string>

required

Available options:

charge,

transfer,

payment,

settlement,

airtime,

reversal,

bank_deposit,

bank_withdrawal

Example:

"charge"

data.paymentMethod

enum<string>

required

Available options:

mobile_money,

bank

Example:

"mobile_money"

data.processor

enum<string>

required

Available options:

mpesa,

choicebank

Example:

"mpesa"

data.createdAt

integer

required

Unix timestamp in milliseconds

Example:

1723717200000

data.updatedAt

integer

required

Unix timestamp in milliseconds

Example:

1723717320000

data.merchantTransactionId

string | null

Your merchant reference

Example:

"mtx_123"

data.message

string | null

Example:

"Payment completed successfully"

data.amount

integer | null

Transaction amount in smallest unit

Example:

10000

data.chargedAmount

integer | null

Amount charged to customer

Example:

10000

data.processorReference

string | null

Reference from payment processor

Example:

"ODI31ABC123"

data.phoneNumber

string | null

Example:

"+254712345678"

data.narration

string | null

Example:

"Invoice #1234"

data.customerId

string | null

Internal customer ID

data.customer

object

Customer details if available

data.fees

integer | null

Total fees charged (in smallest unit)

Example:

100

Transaction objectCanonical transaction fields for C2B charges and B2C payouts

⌘I

JavaScript

import FingoPay from '@fingoafrica/fingo-pay';

const client = new FingoPay({
  apiKey: process.env['FINGO_PAY_API_KEY'], // This is the default and can be omitted
});

const transaction = await client.transactions.get();

console.log(transaction.data);

{
  "status": "success",
  "message": "Transaction fetched",
  "data": {
    "publicId": "txn_01j7b6f9p5y9h",
    "status": "completed",
    "currency": "KES",
    "accountType": "collections",
    "type": "charge",
    "paymentMethod": "mobile_money",
    "processor": "mpesa",
    "createdAt": 1723717200000,
    "updatedAt": 1723717320000,
    "merchantTransactionId": "mtx_123",
    "message": "Payment completed successfully",
    "amount": 10000,
    "chargedAmount": 10000,
    "processorReference": "ODI31ABC123",
    "phoneNumber": "+254712345678",
    "narration": "Invoice #1234",
    "customerId": "<string>",
    "customer": {},
    "fees": 100
  }
}

Overview

Payments

Payouts

Accounts

Transactions

Models

Get transaction by ID or merchantTransactionId

Authorizations

Query Parameters

Response