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

Create New Discount Code.

Endpoint Overview

POST /api/payment-service/external/v1/products/add-discount-code Requires authentication

Purpose

Use this endpoint to create new discount code. It belongs to the Products collection and is designed for backend integrations.

Request shape

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

Request Body

Content type: application/json

productId:
number
No description provided.
code required
string
No description provided.
value required
number
No description provided.
discounttype required
string
No description provided.
minOrderAmount
number
No description provided.
maxUsePerCustomer
number
No description provided.
maxClaims
number
No description provided.
startDate
string
No description provided.
endDate
string
No description provided.
isActive
boolean
No description provided.
isDelete
boolean
No description provided.

Responses

200 discount code create sucessfully
400 Bad request

Expected Outcomes

200

Success example

discount code create sucessfully

Representative Response
{
  "status": "success",
  "message": "Request processed successfully",
  "data": {
    "reference": "PM-REF-12345"
  }
}
400

Failure example

Bad request

Representative Error
{
  "status": "error",
  "message": "Invalid request payload. Check `productId:` and try again.",
  "errors": {
    "productId:": [
      "`productId:` is required."
    ]
  }
}
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 = {
  "productId:": 0.0,
  "code": "value",
  "value": 0.0,
  "discounttype": "value",
  "minOrderAmount": 0.0
}

response = requests.post(
    "https://api.paymish.com/api/payment-service/external/v1/products/add-discount-code",
    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/products/add-discount-code",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "productId:": 0.0,
  "code": "value",
  "value": 0.0,
  "discounttype": "value",
  "minOrderAmount": 0.0
}
});

console.log(response.data);
cURL
curl https://api.paymish.com/api/payment-service/external/v1/products/add-discount-code \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "productId:": 0.0,   "code": "value",   "value": 0.0,   "discounttype": "value",   "minOrderAmount": 0.0 }'
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/payment-service/external/v1/products/add-discount-code");
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([
    "productId:" => 0.0,
    "code" => "value",
    "value" => 0.0,
    "discounttype" => "value",
    "minOrderAmount" => 0.0,
]));

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