Stellar · Schema

Disbursement

BlockchainCryptocurrencyDecentralized ExchangeLedgerPaymentsSmart ContractsWeb3

Properties

Name	Type	Description
id	string	The unique identifier of the disbursement
name	string	The name of the disbursement
receiver_registration_message_template	string	The custom template used to send invitations to receivers. The `default` message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} w
registration_contact_type	object
wallet	object
asset	object
status	object
verification_field	object
status_history	object
file_name	string
created_at	string
updated_at	string
total_payments	integer	Total number of payments
total_payments_sent	integer	Total number of successful payments
total_payments_failed	integer	Total number of failed payments
total_payments_remaining	integer	Total number of remaining payments
amount_disbursed	string	The total amount disbursed so far
total_amount	string	The total amount to be disbursed
average_amount	string	The average amount per payment

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developers.stellar.org/schemas/sdp/Disbursement.json",
  "title": "Disbursement",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the disbursement",
      "example": "619da857-8725-4c58-933d-c120a458e0f5"
    },
    "name": {
      "type": "string",
      "description": "The name of the disbursement",
      "example": "Disbursement Name"
    },
    "receiver_registration_message_template": {
      "type": "string",
      "description": "The custom template used to send invitations to receivers. The `default` message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.RegistrationLink}} which is the link generated by SDP to send to the receiver (in case this is not present in the message, it's automatically appended at the end).",
      "example": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register."
    },
    "registration_contact_type": {
      "$ref": "#/components/schemas/RegistrationContactType"
    },
    "wallet": {
      "$ref": "#/components/schemas/Wallet"
    },
    "asset": {
      "$ref": "#/components/schemas/Asset"
    },
    "status": {
      "$ref": "#/components/schemas/DisbursementStatus"
    },
    "verification_field": {
      "$ref": "#/components/schemas/VerificationField"
    },
    "status_history": {
      "$ref": "#/components/schemas/DisbursementStatusHistory"
    },
    "file_name": {
      "type": "string",
      "example": "disbursement-feb-03-2023.csv"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2023-02-03T10:45:51Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2023-02-03T10:45:51Z"
    },
    "total_payments": {
      "type": "integer",
      "description": "Total number of payments",
      "example": 10
    },
    "total_payments_sent": {
      "type": "integer",
      "description": "Total number of successful payments",
      "example": 8
    },
    "total_payments_failed": {
      "type": "integer",
      "description": "Total number of failed payments",
      "example": 1
    },
    "total_payments_remaining": {
      "type": "integer",
      "description": "Total number of remaining payments",
      "example": 1
    },
    "amount_disbursed": {
      "type": "string",
      "description": "The total amount disbursed so far",
      "example": "800.00"
    },
    "total_amount": {
      "type": "string",
      "description": "The total amount to be disbursed",
      "example": "1000.00"
    },
    "average_amount": {
      "type": "string",
      "description": "The average amount per payment",
      "example": "100.00"
    }
  }
}