Get Organization Info

GET 
/organization

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.

Responses

200

Returns organization details

application/json

Schema

Schema

namestringrequired
Example: Stellar Aid
logo_urlstringrequired
Example: https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo
distribution_account objectrequired
addressstring
The address of the distribution account, present when the account type is STELLAR.
Example: GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL
circle_wallet_idstring
The ID of the Circle wallet, present when the account type is CIRCLE.
Example: 1000646072
typestringrequired
The type of the distribution account.
Possible values: [DISTRIBUTION_ACCOUNT.STELLAR.ENV, DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT, DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT]
Example: DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT
statusstringrequired
Possible values: [ACTIVE, PENDING_USER_ACTIVATION]
Example: ACTIVE
distribution_account_public_keystring
DEPRECATED! Please refer to distribution_account.address instead.
Example: GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL
timezone_utc_offsetstringrequired
Example: +00:00
is_approval_requiredbooleanrequired
Enables multi-user approval workflow for disbursements
Example: true
receiver_invitation_resend_interval_daysintegerrequired
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_daysintegerrequired
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_linkstringrequired
The link to the organization privacy policy
Example: https://stellar.org/privacy-policy
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).
Example: You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.
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: {{.OTP}} is your {{.OrganizationName}} phone verification code.

Example (auto)

{
  "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,
  "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."
}

401

Unauthorized

application/json

Schema

Schema

errorstring
extras object
statusnumber
messagestring

Example (auto)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Authorization: Authorization

name: Authorizationtype: apiKeydescription: JWT used for authentication, signed with an ES256 private key.in: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://developers-pr1413.previews.kube001.services.stellar-ops.com/organization");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "<Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

Auth

BearerAuth

ResponseClear

Click the Send API Request button above and see the response here!