POST /split

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
bearer_subaccount String No

This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type

name String Yes

Name of the transaction split

bearer_type String No

This allows you specify how the transaction charge should be processed

Valid values:

  • "all-proportional"
  • "account"
  • "subaccount"
  • "all"
subaccounts[] Array Yes

A list of object containing subaccount code and number of shares

subaccounts[].share String No

The percentage or flat quota of the customer or partner

subaccounts[].subaccount String No

Subaccount code of the customer or partner

type String Yes

The type of transaction split you want to create.

Valid values:

  • "flat"
  • "percentage"
currency String Yes

The transaction currency

Valid values:

  • "ZAR"
  • "GHS"
  • "USD"
  • "NGN"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.