Stellar · Schema

Organization

BlockchainCryptocurrencyDecentralized ExchangeLedgerPaymentsSmart ContractsWeb3

Properties

Name	Type	Description
name	string
logo_url	string
distribution_account	object
distribution_account_public_key	string	DEPRECATED! Please refer to distribution_account.address instead.
timezone_utc_offset	string
is_approval_required	boolean	Enables multi-user approval workflow for disbursements
receiver_invitation_resend_interval_days	integer	The amount of days that the SDP will wait to resend the invitation to the receivers that have not registered. If `0`, that means the resending invitation feature is disabled.
payment_cancellation_period_days	integer	The amount of days that the SDP will wait to cancel a payment that is waiting for the receiver to register. If `0`, that means the payment cancellation feature is disabled.
privacy_policy_link	string	The link to the organization privacy policy
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
otp_message_template	string	The custom OTP message template set to send OTP code to the receiver complete the registration flow. The `default` message isn't returned. In the message's content it's possible to add the following t

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developers.stellar.org/schemas/sdp/Organization.json",
  "title": "Organization",
  "required": [
    "distribution_account",
    "is_approval_required",
    "logo_url",
    "name",
    "payment_cancellation_period_days",
    "privacy_policy_link",
    "receiver_invitation_resend_interval_days",
    "timezone_utc_offset"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "Stellar Aid"
    },
    "logo_url": {
      "type": "string",
      "example": "https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo"
    },
    "distribution_account": {
      "$ref": "#/components/schemas/DistributionAccount"
    },
    "distribution_account_public_key": {
      "type": "string",
      "description": "DEPRECATED! Please refer to distribution_account.address instead.",
      "example": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"
    },
    "timezone_utc_offset": {
      "type": "string",
      "example": "+00:00"
    },
    "is_approval_required": {
      "type": "boolean",
      "description": "Enables multi-user approval workflow for disbursements",
      "example": true
    },
    "receiver_invitation_resend_interval_days": {
      "type": "integer",
      "description": "The amount of days that the SDP will wait to resend the invitation to the receivers that have not registered. If `0`, that means the resending invitation feature is disabled.",
      "example": 5
    },
    "payment_cancellation_period_days": {
      "type": "integer",
      "description": "The amount of days that the SDP will wait to cancel a payment that is waiting for the receiver to register. If `0`, that means the payment cancellation feature is disabled.",
      "example": 5
    },
    "privacy_policy_link": {
      "type": "string",
      "description": "The link to the organization privacy policy",
      "example": "https://stellar.org/privacy-policy"
    },
    "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."
    },
    "otp_message_template": {
      "type": "string",
      "description": "The custom OTP message template set to send OTP code to the receiver complete the registration flow. 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 {{.OTP}} which is the OTP code to send to the receiver complete the registration flow (in case this is not present in the message, it's automatically appended at the end).",
      "example": "{{.OTP}} is your {{.OrganizationName}} phone verification code."
    }
  }
}