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

Transaction with Card.

Endpoint Overview

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

Purpose

Use this endpoint to submit transaction with card. 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

customerId required
number
Unique identifier for the customer. Example: 5
planId required
number
Unique identifier for the plan. Example: 5
channel required
string
The channel through which the transaction is made. Example: string
amount required
number
Amount of the transaction. Example: 100
ipAddress
string
IP address of the customer making the transaction. Example: 192.168.0.1
fees
number
Fees associated with the transaction. Example: 1.2
message
string
Additional message or information related to the transaction. Example: message
cardNumber required
number
Card number used for the transaction. Example: 5123450161003312
expiryYear required
integer
Expiry year of the card. Example: 2024
expiryMonth required
integer
Expiry month of the card. Example: 12
cvv required
integer
CVV of the card. Example: 123
isLive
boolean
Indicates if the transaction is in a live environment. Example: True

Responses

200 Transaction successful.
400 Bad request.

Expected Outcomes

200

Success example

Transaction successful.

Representative Response
{
  "message": "Bank list.",
  "paymentDetails": "value",
  "transactionIdForSession": 758
}
400

Failure example

Bad request.

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 = {
  "customerId": 5,
  "planId": 5,
  "channel": "string",
  "amount": 100,
  "ipAddress": "192.168.0.1"
}

response = requests.post(
    "https://api.paymish.com/api/transaction-service/external/v1/transaction-with-card",
    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-card",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "customerId": 5,
  "planId": 5,
  "channel": "string",
  "amount": 100,
  "ipAddress": "192.168.0.1"
}
});

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

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