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

Create a transaction with a bank

Endpoint Overview

POST /api/transaction-service/external/v1/transaction-with-bank Requires authentication

Purpose

Use this endpoint to create a transaction with a bank. It belongs to the Transaction collection and is designed for backend integrations.

Request shape

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

Request Body

Content type: application/json

pageId
integer
ID of the page. Example: 1
orderId
integer
ID of the order. Example: 1
customerId
integer
ID of the customer. Example: 8
channel
string
Channel of the transaction. Example: NIBSS
amount
number
Amount of the transaction. Example: 100
ipAddress
string
IP address associated with the transaction. Example: string
fees
number
Fees associated with the transaction. Example: 1.2
message
string
Message associated with the transaction. Example: message
AccountNumber
string
Account number for the transaction. Example: 1780004070
DestinationInstitutionCode
string
Institution code of the destination bank. Example: 999998
location
string
Location coordinates. Example: 1.38716,3.05117
isLive
boolean
Flag indicating if the transaction is live. Example: True

Responses

200 The transaction was created successfully.
500 Internal Server Error.

Expected Outcomes

200

Success example

The transaction was created successfully.

Representative Response
{}
500

Failure example

Internal Server Error.

Representative Error
{
  "message": "No banks found",
  "code": 404,
  "error": "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 = {
  "pageId": 1,
  "orderId": 1,
  "customerId": 8,
  "channel": "NIBSS",
  "amount": 100
}

response = requests.post(
    "https://api.paymish.com/api/transaction-service/external/v1/transaction-with-bank",
    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-bank",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "pageId": 1,
  "orderId": 1,
  "customerId": 8,
  "channel": "NIBSS",
  "amount": 100
}
});

console.log(response.data);
cURL
curl https://api.paymish.com/api/transaction-service/external/v1/transaction-with-bank \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "pageId": 1,   "orderId": 1,   "customerId": 8,   "channel": "NIBSS",   "amount": 100 }'
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/transaction-service/external/v1/transaction-with-bank");
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([
    "pageId" => 1,
    "orderId" => 1,
    "customerId" => 8,
    "channel" => "NIBSS",
    "amount" => 100,
]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
Sample Response 200 OK
{}