Skip to main content
POST
Create Split Account

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

X-TenantID
string
header
required

live or test

Body

application/json
account_no
string
required

The beneficiary bank account number.

Example:

"0123456789"

account_name
string
required

The name of the beneficiary bank account.

Example:

"John Doe"

bank_code
string
required

The bank code of the beneficiary bank.

Example:

"000001"

name
string
required

The name assigned to the Split Account.

Example:

"John doe"

email
string<email>
required

The beneficiary email address.

Example:

"johndoe@gmail.com"

currency
string
required

The settlement currency (ISO 4217).

Example:

"NGN"

country
string
required

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

Example:

"NGA"

split_type
string
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

Example:

"PERCENTAGE"

split_value
number
required

Percentage or flat amount allocated to the Payaza Account owner.

Example:

2

Response

Create Split Account Response

code
string

System operational status response code tracking the request transaction performance.

Example:

"00"

success
boolean

Indicates if the request completed successfully.

Example:

true

error
string | null

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

Example:

null

data
object

The payload containing tracking identifiers generated for the new split account configuration.

message
string

Descriptive message confirming the configuration outcome.

Example:

"split account created successfully"