Referral partners

Base URL: https://referral-api.debitura.com
Authentication: API key in the XApiKey header

Get authenticated partner information

GET/me

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.

Returns

200 Partner information retrieved successfully

iduuid
Unique identifier for the referral partner.
companyNamestringnullable
Company name of the referral partner.
shortNamestringnullable
Short name of the referral partner.
contactEmailstringnullable
Contact email for the referral partner.
externalSystemIdstringnullable
External system identifier for the partner.
referralFeePercentagenumber
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.
logoUrlstringnullable
URL to the referral partner's logo image.
backgroundColorCodestringnullable
Background color code for custom styling (e.g., "#FFFFFF").
fontColorstringnullable
Font color code for custom styling (e.g., "#000000").
fontFamilystringnullable
Font family for custom styling (e.g., "Arial, sans-serif").
invoicingTriggerModeenumnullable
What condition triggers payouts to become ready to invoice Debitura for this partner. Null means the platform default (pay-when-paid). Set by Debitura; read-only here.
One ofPayWhenPaidConfirmedPipelinenull
billingModeenum
One ofPartnerInvoiceSelfBilling

Errors

`404`	Referral partner not found (invalid configuration)
`500`	Internal server error

See Error handling.

GET/me

curl https://referral-api.debitura.com/me \
  -H "XApiKey: $DEBITURA_API_KEY"

Response

{
  "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
  "companyName": "Muster GmbH",
  "shortName": "Muster GmbH",
  "contactEmail": "finance@example.com",
  "externalSystemId": "string",
  "referralFeePercentage": 2500,
  "isActive": true,
  "isPublicDemo": true,
  "logoUrl": "https://app.debitura.com/…",
  "backgroundColorCode": "string",
  "fontColor": "string",
  "fontFamily": "string",
  "invoicingTriggerMode": "PayWhenPaid",
  "billingMode": "PartnerInvoice"
}