Payouts & Wallet Details

📘 Overview

Payouts (withdrawals) transfer funds from your Prestmit wallet to a linked bank account.

Prerequisites

Before creating a payout, ensure you have:

A funded wallet (Naira or Cedis)
At least one verified bank account registered to your account

🏦 Available Endpoints

Endpoint	Method	Purpose
`/wallet/fiat/create-withdrawal`	POST	Create a new withdrawal request
`/wallet/fiat/withdrawal-history`	GET	Retrieve paginated withdrawal history
`/wallet/fiat/withdrawal-history/{id}/receipt`	GET	Get detailed withdrawal receipt
`/wallet/fiat/details`	GET	Get current wallet balance and status

📝 Creating a Withdrawal Request

Endpoint: POST /wallet/fiat/create-withdrawal

This endpoint transfers funds from your wallet to a registered bank account.

Request Parameters

Field	Type	Required	Description
`bankAccountId`	Number	Yes	ID of your saved bank account
`amount`	Number	Yes	Amount to withdraw (in minor units)
`wallet`	String	Yes	Wallet currency (`NAIRA` or `CEDIS`)
`currentAccountPIN`	String	Yes	Your account PIN for authorization
`2fa_code`	Number	Conditional	Required if 2FA is enabled on your account.
`uniqueIdentifier`	String	Conditional	Optional unique identifier for linking this withdrawal record to your system. This could be tied to an internal reference or user identifier.

Example Request

{
  "bank_account_id": 12345,
  "amount": 50000,
  "wallet": "NAIRA",
  "current_account_pin": "1234",
  "two_fa_code": 987654
}

Example Response

{
  "success": true,
  "message": "Withdrawal request created successfully",
  "data": {
    "id": 67890,
    "reference": "WTH12345678",
    "amount": 50000,
    "fee": 100,
    "totalDebit": 50100,
    "status": "processing",
    "bankAccount": {
      "accountNumber": "0123456789",
      "accountName": "JOHN DOE",
      "bankName": "Guaranty Trust Bank"
    },
    "createdAt": "2025-09-04T09:15:30Z",
    "estimatedCompletionTime": "2025-09-04T10:15:30Z"
  }
}

📜 Viewing Withdrawal History

Endpoint: GET /wallet/fiat/withdrawal-history

Returns a paginated list of your past withdrawal transactions.

Query Parameters

Parameter	Type	Required	Description
`page`	Number	No	Page number (default: 1)
`wallet`	String	Yes	Wallet currency (`NAIRA` or `CEDIS`)

Example Request

GET /wallet/fiat/withdrawal-history?page=1&wallet=NAIRA

Example Response

{
  "success": true,
  "data": {
    "withdrawals": [
      {
        "id": 67890,
        "reference": "WTH12345678",
        "amount": 50000,
        "fee": 100,
        "totalDebit": 50100,
        "status": "completed",
        "bankAccount": {
          "accountNumber": "0123456789",
          "accountName": "JOHN DOE",
          "bankName": "GTBank"
        },
        "createdAt": "2025-09-04T09:15:30Z",
        "completedAt": "2025-09-04T09:25:45Z"
      }
    ],
    "pagination": {
      "currentPage": 1,
      "totalPages": 1,
      "totalItems": 1
    }
  }
}

📄 Getting a Withdrawal Receipt

Endpoint: GET /wallet/fiat/withdrawal-history/{withdrawalId}/receipt

Retrieves detailed receipt information for a specific withdrawal transaction.

Path Parameters

Replace {withdrawalId} with the ID of the withdrawal from your history response.

Example Request

GET /wallet/fiat/withdrawal-history/67890/receipt

Example Response

{
  "success": true,
  "data": {
    "receipt": {
      "reference": "WTH12345678",
      "amount": 50000,
      "fee": 100,
      "totalDebit": 50100,
      "status": "completed",
      "bankAccount": {
        "accountNumber": "0123456789",
        "accountName": "JOHN DOE",
        "bankName": "GTBank"
      },
      "createdAt": "2025-09-04T09:15:30Z",
      "completedAt": "2025-09-04T09:25:45Z",
      "sessionId": "SES123456789",
      "receiptUrl": "https://prestmit.com/receipts/WTH12345678.pdf"
    }
  }
}

📊 Checking Wallet Details

Endpoint: GET /wallet/fiat/details

Returns your current wallet balance, pending transactions, and total available amount.

Query Parameters

Parameter	Type	Required	Description
`wallet`	String	Yes	Wallet currency (`NAIRA` or `CEDIS`)

Example Request

GET /wallet/fiat/details?wallet=NAIRA

Example Response

{
  "success": true,
  "data": {
    "wallet": {
      "currency": "NAIRA",
      "balance": 125000,
      "pendingBalance": 0,
      "totalBalance": 125000,
      "lastUpdated": "2025-09-04T09:25:45Z"
    }
  }
}

Field Descriptions

Field	Description
`balance`	Available wallet balance for new transactions
`pendingBalance`	Amount temporarily locked or under processing
`totalBalance`	Total wallet value (available + pending)
`lastUpdated`	Timestamp when wallet data was last refreshed