Stitch · Schema

Disbursement

An outbound payment disbursement.

AfricaFinancial DataOpen BankingPaymentsUnified APISouth AfricaNigeria

Properties

Name	Type	Description
id	string	Disbursement identifier.
status	string	Disbursement status.
amount	object
beneficiaryAccountNumber	string	Recipient's bank account number.
beneficiaryBankId	string	Recipient's bank identifier.
reference	string	Payment reference string.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Disbursement",
  "title": "Disbursement",
  "type": "object",
  "description": "An outbound payment disbursement.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Disbursement identifier."
    },
    "status": {
      "type": "string",
      "enum": [
        "Pending",
        "Processing",
        "Complete",
        "Failed"
      ],
      "description": "Disbursement status."
    },
    "amount": {
      "$ref": "#/components/schemas/MoneyAmount"
    },
    "beneficiaryAccountNumber": {
      "type": "string",
      "description": "Recipient's bank account number."
    },
    "beneficiaryBankId": {
      "type": "string",
      "description": "Recipient's bank identifier."
    },
    "reference": {
      "type": "string",
      "description": "Payment reference string."
    }
  }
}