Brands

List brands

get/v1/brands

Responses

• 200

  OKobject
  Fields

  object"list"required

  dataarray of Brandrequired

  Fields of data

  idstring (uuid)required

  object"brand"required

  namestringrequired

  display_namestring | null

  support_emailstring | null

  statusactive | archivedrequired

  is_defaultbooleanrequired

  The business itself, created at signup with the business name. Can't be archived; anything without a brand belongs to it.

  settlement_bank_accountstring (uuid) | nullrequired

  Where this brand's naira settles; null uses the business's settlement account.

  categoryretail_ecommerce | fashion_beauty | food_restaurants | supermarkets | education | healthcare_pharmacy | travel_transport | hotels_hospitality | logistics | software_saas | digital_services | media_entertainment | events_tickets | real_estate | construction | agriculture | manufacturing | professional_services | legal | accounting_audit_tax | jewellery_precious_metals | car_dealers | religious_organisation | ngo_charity | other | betting_gaming | crypto_digital_assets | forex_investment | lending_credit | money_transfer or null

  descriptionstring | null

  websitestring | null

  support_phonestring | null

  business_name_numberstring | null

  reviewBrandReviewrequired

  Fields of review

  statuspending | approved | rejected | suspendedrequired

  Only approved brands take live payments. A suspended brand's live balance isn't paid out or settled.

  reasonstring | nullrequired

  Compliance's reason for a rejection or suspension.

  risklow | review | restricted | nullrequired

  null for the business's own brand.

  licence_neededstring | nullrequired

  The licence a restricted category needs.

  requirementsarray of licencerequired

  Still needed before compliance can approve.

  submitted_atstring (date-time) | nullrequired

  reviewed_atstring (date-time) | nullrequired

  created_atstring (date-time)required

  has_moreboolean