Paymish Loading Docs Preparing guides, collections, and live API references...
Paymish Docs

Create a new split page

Topics

Endpoint Overview

SplitPages

Create a new split page

POST /api/transaction-service/external/v1/split-page Requires authentication

Purpose

Use this endpoint to create a new split page. It belongs to the SplitPages collection and is designed for backend integrations.

Request shape

0 parameters and 14 documented body fields using application/json.

Implementation Guide

Recommended workflow

1

Authenticate first and inject a valid bearer token or secret key before calling the endpoint.

2

Validate the input data, identifiers, and account state in your application before making the request.

3

Send the POST request from your backend using the required headers and the expected content type (application/json).

4

Persist the important identifiers returned in the response so later lookups, webhooks, or support actions can be linked correctly.

Implementation notes

  • Validate the request payload on your backend before sending it, especially the 14 documented body fields.
  • Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Request Body

Content type: application/json

name required
string
Name of the split page. Example: fdhfdh
type required
string
The type of split (e.g., percentage, fixed). Example: percentage
currency required
string
Currency code for the split. Example: NGN
integration required
integer
Integration identifier for the split.
domain required
string
Domain associated with the split page. Example: test
active required
boolean
Indicates if the split page is active. Example: True
bearer_type
string
Type of bearer associated with the split.
bearer_subaccount
string
Subaccount associated with the bearer.
createdAt
string
Date and time when the split page was created.
updatedAt
string
Date and time when the split page was last updated.
is_dynamic
boolean
Indicates if the split is dynamic. Example: True
subaccounts
array[object]
Array of subaccounts
id
integer
Unique identifier of the split page. Example: 55
split_code
string
Unique code identifying the split. Example: SPL_8bXAewX81723109262806

Responses

201 The split page was successfully created
500 Some server error

Expected Outcomes

201

Success example

The split page was successfully created

Representative Response 
{
  "status": "success",
  "message": "Request processed successfully",
  "data": {
    "reference": "PM-REF-12345"
  }
}
500

Failure example

Some server error

Representative Error 
{
  "status": "error",
  "message": "Invalid request payload. Check `name` and try again.",
  "errors": {
    "name": [
      "`name` is required."
    ]
  }
}
After the response:
  • Log the Paymish reference or request context returned by the API so support teams can trace the call later.
  • Retry only when the failure is safe to repeat; otherwise correct the payload or auth state first.
  • Store enough internal metadata to match the API response back to your order, payout, case, or checkout record.

Language Notes

Python

Use `requests` from a backend worker, service, or Django/Flask app and centralize headers in a reusable helper.

Node.js

Use `axios` or `fetch` from Node.js services only; do not place secret credentials in frontend bundles.

PHP

Wrap cURL usage in a small client class so auth headers, error handling, and logging stay consistent.

cURL

Use cURL for smoke testing and debugging, then move the final logic into your backend service code.

Code Examples

Python 
import requests

headers = {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
}
payload = {
  "name": "fdhfdh",
  "type": "percentage",
  "currency": "NGN",
  "integration": 0,
  "domain": "test"
}

response = requests.post(
    "https://api.paymish.com/api/transaction-service/external/v1/split-page",
    headers=headers,
    json=payload,
)

data = response.json()
print(data)
Node.js 
const axios = require("axios");

const response = await axios({
  method: "post",
  url: "https://api.paymish.com/api/transaction-service/external/v1/split-page",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "name": "fdhfdh",
  "type": "percentage",
  "currency": "NGN",
  "integration": 0,
  "domain": "test"
}
});

console.log(response.data);
cURL 
curl https://api.paymish.com/api/transaction-service/external/v1/split-page \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "name": "fdhfdh",   "type": "percentage",   "currency": "NGN",   "integration": 0,   "domain": "test" }'
PHP 
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/transaction-service/external/v1/split-page");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "name" => "fdhfdh",
    "type" => "percentage",
    "currency" => "NGN",
    "integration" => 0,
    "domain" => "test",
]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
Previous endpoint Get List of Businesses Next endpoint Returns the list of all split pages