Stellar · Schema

DisbursementLite

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}}`
registration_contact_type	object
status	object
verification_field	object
status_history	object
file_name	string
created_at	string	The creation timestamp of the disbursement
updated_at	string	The last update timestamp of the disbursement

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developers.stellar.org/schemas/sdp/DisbursementLite.json",
  "title": "DisbursementLite",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the disbursement",
      "format": "uuid",
      "example": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43"
    },
    "name": {
      "type": "string",
      "description": "The name of the disbursement",
      "example": "disbursement-june-29"
    },
    "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"
    },
    "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",
      "description": "The creation timestamp of the disbursement",
      "format": "date-time",
      "example": "2023-06-30T01:22:57.831975Z"
    },
    "updated_at": {
      "type": "string",
      "description": "The last update timestamp of the disbursement",
      "format": "date-time",
      "example": "2023-06-30T01:22:58.316511Z"
    }
  }
}