STstellar
Organization

Get Organization Info

Changed on

This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.

get/organization

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Response

Returns organization details

namestring required
logo_urlstring required
distribution_account_public_keystring

DEPRECATED! Please refer to distribution_account.address instead.

timezone_utc_offsetstring required
is_approval_requiredboolean required

Enables multi-user approval workflow for disbursements

receiver_invitation_resend_interval_daysinteger required

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_daysinteger required

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.

webhook_urlstring uri nullable

HTTPS destination the SDP delivers outbox events to. Must use https.

privacy_policy_linkstring required

The link to the organization privacy policy

reporting_enabledboolean

Whether the Reports feature is on for the organization (default false).

receiver_registration_message_templatestring

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).

otp_message_templatestring

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 response

{
  "name": "Stellar Aid",
  "logo_url": "https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo",
  "distribution_account": {
    "address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
    "circle_wallet_id": "1000646072",
    "type": "DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT",
    "status": "ACTIVE"
  },
  "distribution_account_public_key": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
  "timezone_utc_offset": "+00:00",
  "is_approval_required": true,
  "receiver_invitation_resend_interval_days": 5,
  "payment_cancellation_period_days": 5,
  "webhook_url": "https://example.org/sdp-events",
  "privacy_policy_link": "https://stellar.org/privacy-policy",
  "receiver_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
  "otp_message_template": "{{.OTP}} is your {{.OrganizationName}} phone verification code."
}

Changes