Moniepoint · Schema

Monnify Transaction

Schema for the core Monnify collection transaction object returned by Initialize Transaction, Get Transaction Status, and Search Transactions endpoints under /api/v1/merchant/transactions/ and /api/v2/merchant/transactions/.

AfricaNigeriaPaymentsBankingFintechAcquiringPoint-of-SaleCollectionDisbursementsVirtual AccountsDirect DebitBills PaymentSMBWorking CapitalUnicorn

Properties

Name Type Description
transactionReference string Monnify-assigned reference for the transaction.
paymentReference string Merchant-supplied unique reference.
merchantName string
apiKey string Merchant API key used to initialize the transaction.
contractCode string
amount number
amountPaid number
currencyCode string
customerName string
customerEmail string
checkoutUrl string
paymentStatus string
paymentMethod string
paymentDescription string
redirectUrl string
settlementAmount number
completedOn string
paidOn string
metaData object
incomeSplitConfig array
View JSON Schema on GitHub

JSON Schema

monnify-transaction-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.com/schemas/moniepoint/monnify-transaction-schema.json",
  "title": "Monnify Transaction",
  "description": "Schema for the core Monnify collection transaction object returned by Initialize Transaction, Get Transaction Status, and Search Transactions endpoints under /api/v1/merchant/transactions/ and /api/v2/merchant/transactions/.",
  "type": "object",
  "properties": {
    "transactionReference": {
      "type": "string",
      "description": "Monnify-assigned reference for the transaction."
    },
    "paymentReference": {
      "type": "string",
      "description": "Merchant-supplied unique reference."
    },
    "merchantName": { "type": "string" },
    "apiKey": { "type": "string", "description": "Merchant API key used to initialize the transaction." },
    "contractCode": { "type": "string" },
    "amount": { "type": "number", "minimum": 0 },
    "amountPaid": { "type": "number", "minimum": 0 },
    "currencyCode": { "type": "string", "example": "NGN" },
    "customerName": { "type": "string" },
    "customerEmail": { "type": "string", "format": "email" },
    "checkoutUrl": { "type": "string", "format": "uri" },
    "paymentStatus": {
      "type": "string",
      "enum": ["PAID", "OVERPAID", "PARTIALLY_PAID", "PENDING", "FAILED", "EXPIRED"]
    },
    "paymentMethod": {
      "type": "string",
      "enum": ["CARD", "ACCOUNT_TRANSFER", "USSD", "PHONE_NUMBER", "DIRECT_DEBIT"]
    },
    "paymentDescription": { "type": "string" },
    "redirectUrl": { "type": "string", "format": "uri" },
    "settlementAmount": { "type": "number" },
    "completedOn": { "type": "string", "format": "date-time" },
    "paidOn": { "type": "string", "format": "date-time" },
    "metaData": {
      "type": "object",
      "additionalProperties": { "type": "string" }
    },
    "incomeSplitConfig": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "subAccountCode": { "type": "string" },
          "feePercentage": { "type": "number" },
          "splitPercentage": { "type": "number" },
          "splitAmount": { "type": "number" },
          "feeBearer": { "type": "boolean" }
        }
      }
    }
  },
  "required": ["paymentReference", "amount", "currencyCode", "paymentStatus"]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/monnify-transaction"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.