Paystack · JSON Structure

Paystack Split Structure

JSON Structure for a Paystack multi-party transaction split.

Type: object Properties: 12 Required: 5
PaymentsAfricaFintechRecurring BillingMarketplacesPayoutsMobile MoneyStripe

PaystackSplit is a JSON Structure definition published by Paystack, describing 12 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/extended/v0/# meta-schema.

Properties

id split_code name type currency bearer_type bearer_subaccount active is_dynamic subaccounts total_subaccounts created_at

Meta-schema: https://json-structure.org/meta/extended/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/extended/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/paystack/main/json-structure/paystack-split-structure.json",
  "name": "PaystackSplit",
  "type": "object",
  "description": "JSON Structure for a Paystack multi-party transaction split.",
  "properties": {
    "id": { "type": "int64" },
    "split_code": { "type": "string", "description": "Prefixed with SPL_." },
    "name": { "type": "string" },
    "type": { "type": "string", "description": "percentage or flat." },
    "currency": { "type": "string" },
    "bearer_type": { "type": "string", "description": "Who bears the Paystack fee: account, subaccount, all-proportional, all." },
    "bearer_subaccount": { "type": "string" },
    "active": { "type": "boolean" },
    "is_dynamic": { "type": "boolean" },
    "subaccounts": {
      "type": "array",
      "items": { "type": "object" }
    },
    "total_subaccounts": { "type": "int32" },
    "created_at": { "type": "string", "format": "date-time" }
  },
  "required": ["split_code", "name", "type", "currency", "subaccounts"]
}