v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Split Settlements

Create Split Account

This creates a new split settlement account for the authenticated merchant. It can be referenced during Checkout transactions.

Note:

A unique split account code is generated when a split account is successfully created.
This code is required when configuring split settlements in the Checkout SDK.

post/settlement/settlement/merchant/split-account

Request body

account_nostring required

The beneficiary bank account number.

account_namestring required

The name of the beneficiary bank account.

bank_codestring required

The bank code of the beneficiary bank.

namestring required

The name assigned to the Split Account.

emailstring email required

The beneficiary email address.

currencystring required

The settlement currency (ISO 4217).

countrystring required

The country code (ISO 3166-1 Alpha-3).

split_typestring required

The calculation mechanism applied to process transaction splits (e.g., PERCENTAGE, FLAT). PERCENTAGE allocates funds on a percentage of the transaction amount while FLAT allocates a fixed amount from the transaction

split_valuenumber required

Percentage or flat amount allocated to the Payaza Account owner.

Example request

{
  "account_no": "0123456789",
  "account_name": "John Doe",
  "bank_code": "000001",
  "name": "John doe",
  "email": "johndoe@gmail.com",
  "currency": "NGN",
  "country": "NGA",
  "split_type": "PERCENTAGE",
  "split_value": 2
}

Response

Create Split Account Response

codestring

System operational status response code tracking the request transaction performance.

successboolean

Indicates if the request completed successfully.

errorstring nullable

Details regarding operational processing failure conditions. Returns null on success context.

messagestring

Descriptive message confirming the configuration outcome.

Example response

{
  "code": "00",
  "success": true,
  "data": {
    "code": "SSA_C0900E891783950401871",
    "id": 114
  },
  "message": "split account created successfully"
}