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

Process Payment

Endpoint Overview

POST /api/payment-service/external/v1/utility/transactions/process-payment Requires authentication

Purpose

Use this endpoint to submit process payment. It belongs to the Utility collection and is designed for backend integrations.

Request shape

0 parameters and 9 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 9 documented body fields.
  • Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Request Body

Content type: application/json

paymentReference
string
No description provided. Example: 5352405452351
customerId
string
No description provided. Example: 0101160313181
packageSlug
string
No description provided. Example: MTN_NIGERIA
channel
string
No description provided. Example: WEB
amount
number
No description provided. Example: 6800.5
customerName
string
No description provided. Example: Tester Example
phoneNumber
string
No description provided. Example: 23480812345
email
string
No description provided. Example: tester.example@sample.com
accountNumber
string
No description provided. Example: 0012345678

Responses

200 Successfully processed payment.
412 Precondition Failed - The customer enquiry must be called first.
500 Failed to process payment.

Expected Outcomes

200

Success example

Successfully processed payment.

Representative Response
{
  "error": false,
  "status": "success",
  "message": "Successfully processed the vend request",
  "responseCode": "00",
  "responseData": "value"
}
500

Failure example

Failed to process payment.

Representative Error
{
  "error": true,
  "message": "Internal Server Error"
}
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 = {
  "paymentReference": "5352405452351",
  "customerId": "0101160313181",
  "packageSlug": "MTN_NIGERIA",
  "channel": "WEB",
  "amount": 6800.5
}

response = requests.post(
    "https://api.paymish.com/api/payment-service/external/v1/utility/transactions/process-payment",
    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/payment-service/external/v1/utility/transactions/process-payment",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "paymentReference": "5352405452351",
  "customerId": "0101160313181",
  "packageSlug": "MTN_NIGERIA",
  "channel": "WEB",
  "amount": 6800.5
}
});

console.log(response.data);
cURL
curl https://api.paymish.com/api/payment-service/external/v1/utility/transactions/process-payment \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "paymentReference": "5352405452351",   "customerId": "0101160313181",   "packageSlug": "MTN_NIGERIA",   "channel": "WEB",   "amount": 6800.5 }'
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/payment-service/external/v1/utility/transactions/process-payment");
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([
    "paymentReference" => "5352405452351",
    "customerId" => "0101160313181",
    "packageSlug" => "MTN_NIGERIA",
    "channel" => "WEB",
    "amount" => 6800.5,
]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);