Nomba · Schema

ChargeResponse

PaymentsFintechBankingTransfersVirtual AccountsCheckoutCross-Border PaymentsCards

Properties

Name Type Description
code string Response status code.
description string Human-readable description of the response.
data object
View JSON Schema on GitHub

JSON Schema

nomba-chargeresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChargeResponse",
  "title": "ChargeResponse",
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Response status code.",
      "example": "00"
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of the response.",
      "example": "Success"
    },
    "data": {
      "type": "object",
      "properties": {
        "orderReference": {
          "type": "string",
          "description": "The order reference for the charged transaction."
        },
        "transactionId": {
          "type": "string",
          "description": "The unique identifier for the transaction."
        },
        "status": {
          "type": "string",
          "description": "The status of the charge.",
          "enum": [
            "successful",
            "pending",
            "failed"
          ]
        },
        "amount": {
          "type": "number",
          "format": "double",
          "description": "The amount charged."
        }
      }
    }
  }
}