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

Update a subaccount by ID

Topics

Endpoint Overview

Subaccounts

Update a subaccount by ID

Update the details of a subaccount using its unique identifier.

PUT /api/transaction-service/external/v1/subaccounts/{id} Requires authentication

Purpose

Use this endpoint to update a subaccount by id. It belongs to the Subaccounts collection and is designed for backend integrations.

Request shape

1 parameter and 8 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 PUT 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

  • Construct path parameters carefully and avoid string concatenation mistakes when building the final URL.
  • Validate the request payload on your backend before sending it, especially the 8 documented body fields.
  • Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Path Parameters

id required
integer
Unique identifier of the subaccount.

Request Body

Content type: application/json

business_name
string
Name of the business associated with the subaccount. Example: dfsdhjfgdsjfd
account_number
string
Account number of the subaccount. Example: 1234567890
percentage_charge
integer
Percentage charge for the subaccount. Example: 2
currency
string
Currency code for the subaccount. Example: NGN
bank
integer
Code representing the bank associated with the subaccount. Example: 999004
account_name
string
Account name of the subaccount.
active
boolean
Indicates if the subaccount is active. Example: True
migrate
boolean
Indicates if the subaccount is eligible for migration. Example: True

Responses

200 Subaccount details updated successfully.
400 Bad request. Invalid input data.
404 Subaccount not found.
500 Internal server error.

Expected Outcomes

200

Success example

Subaccount details updated successfully.

Representative Response 
{
  "id": 52,
  "business_name": "dfsdhjfgdsjfd",
  "account_number": "1234567890",
  "percentage_charge": 2,
  "currency": "NGN",
  "bank": 999004,
  "account_name": "new",
  "subaccount_code": "ACCT_u9VQZbdR1722852808569"
}
400

Failure example

Bad request. Invalid input data.

Representative Error 
{
  "message": "Subaccount not found",
  "code": 404,
  "error": "value"
}
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 = {
  "business_name": "dfsdhjfgdsjfd",
  "account_number": "1234567890",
  "percentage_charge": 2,
  "currency": "NGN",
  "bank": 999004
}

response = requests.put(
    "https://api.paymish.com/api/transaction-service/external/v1/subaccounts/{id}",
    headers=headers,
    json=payload,
)

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

const response = await axios({
  method: "put",
  url: "https://api.paymish.com/api/transaction-service/external/v1/subaccounts/{id}",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "business_name": "dfsdhjfgdsjfd",
  "account_number": "1234567890",
  "percentage_charge": 2,
  "currency": "NGN",
  "bank": 999004
}
});

console.log(response.data);
cURL 
curl https://api.paymish.com/api/transaction-service/external/v1/subaccounts/{id} \
  -X PUT \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "business_name": "dfsdhjfgdsjfd",   "account_number": "1234567890",   "percentage_charge": 2,   "currency": "NGN",   "bank": 999004 }'
PHP 
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/transaction-service/external/v1/subaccounts/{id}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "business_name" => "dfsdhjfgdsjfd",
    "account_number" => "1234567890",
    "percentage_charge" => 2,
    "currency" => "NGN",
    "bank" => 999004,
]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
Previous endpoint Get a subaccount by ID Next endpoint Delete a subaccount by ID