Get Merchant Transaction

GET

/api/v1/merchants/customer/transactions/{transaction_id}

Get a single merchant customer transaction by ID

Returns detailed information about a specific customer transaction.

Path Parameters:

transaction_id: Transaction UUID

Returns:
Complete transaction details including:

transaction_id: Unique transaction ID

merchant_id: Merchant ID

currency_id: Currency ID

transaction_type: deposit, payout, refund

status: pending, completed, failed, cancelled

settlement_status: unsettled, settled

amount: Gross transaction amount

fee_amount: Fees charged

net_amount: Net amount (amount - fees)

customer_email: Customer email (if available)

customer_name: Customer name (if available)

customer_phone: Customer phone (if available)

external_reference: External payment reference

idempotency_key: Idempotency key

notes: Transaction notes

meta_data: Additional metadata

created_at: Transaction creation timestamp

completed_at: Completion timestamp (if completed)

Errors:

404: Transaction not found or doesn't belong to this merchant

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Header Params

Responses

🟢200OK

application/json

Successful Response

Body

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/merchants/customer/transactions/64e83f98-47ba-435d-a0fc-87e1212c48f0' \
--header 'x-api-key: <api-key>'

Response Example

200 - Success

{
    "data": {
        "transaction_id": "64e83f98-47ba-435d-a0fc-87e1212c48f0",
        "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
        "currency_id": "dd7fb8f3-c044-4dc5-a4ec-c0595a469876",
        "transaction_type": "deposit",
        "status": "completed",
        "amount": 200.0,
        "fee_amount": 0.0,
        "net_amount": 200.0,
        "created_at": "2025-11-17T17:02:02.006852",
        "updated_at": null,
        "completed_at": "2025-11-17T16:02:02.009258",
        "failed_at": null,
        "settlement_status": "unsettled",
        "settled_at": null,
        "settlement_batch_id": null,
        "customer_email": "test.ngn@example.com",
        "customer_name": "Chidi NGN Test",
        "customer_phone": "+2348012345678",
        "checkout_session_id": null,
        "payment_method": null,
        "payout_type": null,
        "recipient_name": null,
        "recipient_email": null,
        "recipient_phone": null,
        "payout_reason": null,
        "bank_account_number": null,
        "bank_routing_number": null,
        "bank_name": null,
        "account_holder_name": null,
        "mobile_number": null,
        "network_provider": null,
        "provider": null,
        "provider_reference": null,
        "provider_metadata": null,
        "meta_data": {
            "checkout_id": "16bf6799-bcd1-4493-a57e-2b59904be3cc"
        },
        "refunds_transaction_id": null,
        "external_reference": "16bf6799-bcd1-4493-a57e-2b59904be3cc",
        "idempotency_key": null,
        "notes": "Checkout approved: 16bf6799-bcd1-4493-a57e-2b59904be3cc"
    },
    "message": "Transaction retrieved successfully",
    "status": "success"
}

Modified at 2025-11-19 15:18:26

Get Merchant Transactions

Create Checkout