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

Verify a transaction with USSD

Endpoint Overview

POST /api/transaction-service/external/v1/transaction-with-ussd-verify Requires authentication

Purpose

Use this endpoint to submit verify a transaction with ussd. It belongs to the Transaction collection and is designed for backend integrations.

Request shape

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

Request Body

Content type: application/json

ussdTransactionId
string
The USSD transaction ID to verify. Example: 24091010410290301050
isLive
boolean
Flag indicating if the verification is in a live environment.

Responses

200 USSD transaction verified successfully.
500 Internal Server Error.

Expected Outcomes

200

Transaction verified

USSD transaction verified successfully.

Representative Response
{
  "data": "value"
}
404

Verification failed

Internal Server Error.

Representative Error
{
  "status": "error",
  "message": "Transaction verification failed.",
  "errors": {
    "reference": [
      "Transaction reference was not found or is invalid."
    ]
  }
}
After the response:
  • Confirm you are verifying the exact stored Paymish reference from the original checkout attempt.
  • Use verification results to update your internal order or invoice state instead of trusting redirect-only status.
  • Retry only after confirming the payment attempt has had enough time to settle or after receiving the relevant webhook update.

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 = {
  "ussdTransactionId": "24091010410290301050",
  "isLive": false
}

response = requests.post(
    "https://api.paymish.com/api/transaction-service/external/v1/transaction-with-ussd-verify",
    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/transaction-with-ussd-verify",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "ussdTransactionId": "24091010410290301050",
  "isLive": false
}
});

console.log(response.data);
cURL
curl https://api.paymish.com/api/transaction-service/external/v1/transaction-with-ussd-verify \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "ussdTransactionId": "24091010410290301050",   "isLive": false }'
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/transaction-service/external/v1/transaction-with-ussd-verify");
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([
    "ussdTransactionId" => "24091010410290301050",
    "isLive" => false,
]));

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