v8

OpenAPI 3.1.02026-08-033623795.0 MB

Partners

Retrieve a referred business

Retrieves a single referred business and its referral terms.

get/partners/businesses/{id}

Response

partner business retrieved

created_atstring date-time required

When the partner business was created.

idstring required

Partner business ID.

my_partner_tier'first' | 'second' required

Which tier the caller earns on for this business: first (they referred the owner) or second (they referred the first-tier partner).

object'partner_business' required

referral_expires_atstring date-time nullable required

When the referral expires.

referral_started_atstring date-time nullable required

When the referral became active.

status'active' | 'removed' required

Current referral status.

Example response

{
  "account": {
    "capabilities": {
      "accept_bank_payments": "active",
      "accept_bnpl_payments": "active",
      "accept_card_payments": "active",
      "bank_deposit": "active",
      "card_deposit": "active",
      "card_issuing": "active",
      "crypto_deposit": "active",
      "crypto_payout": "active",
      "instant_payout": "active",
      "run_ads": "active",
      "standard_payout": "active",
      "transfer": "active"
    },
    "recommended_actions": [
      {
        "action": "theme_business",
        "status": "optional"
      }
    ],
    "required_actions": [
      {
        "action": "deposit_funds",
        "status": "required"
      }
    ]
  }
}