Sign in

v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Split Settlements

Update Split Account

This updates an existing split settlement account details.

Note:

  • All request body parameters are optional. Include only the fields you want to update.
  • Fields omitted from the request will retain their existing values.
put/settlement/settlement/merchant/split-account/{id}

Path parameters

idinteger required

The unique identifier of the split account.

Request body

account_nostring

The beneficiary bank account number.

account_namestring

The name of the beneficiary bank account.

bank_codestring

The bank code of the beneficiary bank.

namestring

The name assigned to the Split Account.

emailstring email

The beneficiary email address.

currencystring

The settlement currency (ISO 4217).

countrystring

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

split_typestring

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

Percentage or flat amount allocated to the Payaza Account owner.

activeboolean required

Indicates whether the split account configuration is active.

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,
  "active": true
}

Response

Update 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 modification outcome.

Example response

{
  "code": "00",
  "success": true,
  "data": {
    "id": 118,
    "account_no": "1212121212",
    "code": "SSA_E55380AD1783952772114",
    "account_name": "Jane Doe",
    "name": "Janet Doe",
    "email": "janetdoe@gmail.com",
    "bank_code": "100004",
    "bank_name": "OPAY",
    "currency": "NGN",
    "country": "NGA",
    "split_type": "FLAT",
    "split_value": 5000,
    "active": true,
    "created_at": "2026-07-13T14:26:12.115065",
    "last_modified": "2026-07-14T14:19:46.542508009"
  },
  "message": "split account updated successfully"
}