Sign in

v1

latestOpenAPI 3.0.42026-08-042281222.0 KB
ReferralPartners

Get authenticated partner information

Retrieves complete configuration and styling information for the authenticated referral partner.

Authentication

  • Requires a valid API key in the XApiKey header
  • The API key uniquely identifies the referral partner

Response Data

  • Partner identification (ID, system name, display name)
  • Branding configuration (logo URLs, colors, fonts)
  • Revenue sharing percentage
  • Partner status and settings

Use Cases

  • Configure white-label branding for client onboarding pages
  • Display partner-specific styling in integrations
  • Verify partner configuration and settings
  • Retrieve commission/fee percentage for revenue calculations

The styling properties returned can be used to customize the appearance of onboarding pages and other partner-facing interfaces to match the referral partner's branding.

get/me

Response

Partner information retrieved successfully

idstring uuid

Unique identifier for the referral partner.

companyNamestring nullable

Company name of the referral partner.

shortNamestring nullable

Short name of the referral partner.

contactEmailstring nullable

Contact email for the referral partner.

externalSystemIdstring nullable

External system identifier for the partner.

referralFeePercentagenumber double

Percentage of Debitura's earnings that will be paid as referral fee.

isActiveboolean

Whether the partner is currently active.

isPublicDemoboolean

When true, this partner is used for public onboarding demos and may have demo-specific behaviour.

logoUrlstring nullable

URL to the referral partner's logo image.

backgroundColorCodestring nullable

Background color code for custom styling (e.g., "#FFFFFF").

fontColorstring nullable

Font color code for custom styling (e.g., "#000000").

fontFamilystring nullable

Font family for custom styling (e.g., "Arial, sans-serif").

invoicingTriggerMode'PayWhenPaid' | 'ConfirmedPipeline'

Controls what condition triggers a referral partner's payout to become "ready to invoice" Debitura for their referral fee. Per-partner override; see Debitura.Domain.Model.ReferralPartners.ReferralPartner.InvoicingTriggerMode.

This enum is also returned directly on the ReferralPartnerApi GET /me response (ReferralPartnerResponse.InvoicingTriggerMode). Wire format is locked to named PascalCase string values ("PayWhenPaid", "ConfirmedPipeline") via Newtonsoft.Json StringEnumConverter — that host uses Newtonsoft (AddNewtonsoftJson in Program.cs), so a System.Text.Json JsonStringEnumConverter attribute alone would be silently ignored; both are declared so STJ-based consumers (and our own tests) can also deserialize the string form.