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

Create a new payment page.

Topics

Endpoint Overview

Payment Pages

Create a new payment page.

This endpoint allows the creation of a new payment page of various types (Product, Subscription, Payment).

POST /api/payment-service/external/v1/payment-pages/create-pages Requires authentication

Purpose

Use this endpoint to create a new payment page. It belongs to the Payment Pages collection and is designed for backend integrations.

Request shape

0 parameters and 13 documented body fields using multipart/form-data.

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 (multipart/form-data).

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 13 documented body fields.
  • Send file uploads as multipart form data and let your client library set the boundary automatically.
  • Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Request Body

Content type: multipart/form-data

planId
number
The ID of the subscription plan (required if pageType is Subscription). Example: 456
pageType
string
The type of the payment page. Example: Subscription
pageName
string
The name of the payment page. Example: My Payment Page
pageDescription
string
A brief description of the payment page. Example: This is a sample payment page.
seoImage
string
SEO image for the payment page.
isFixedPaymentAmount
boolean
Indicates if the payment amount is fixed. Example: True
fixedPaymentAmount
number
The fixed payment amount. Example: 100
isPhoneNumber
boolean
Indicates if the phone number is required.
customLink
string
The custom link for the payment page. Example: https://example.com/custom-link
redirectAfterPaymentLink
string
The link to redirect after payment. Example: https://example.com/success
successMessage
string
The message displayed after a successful payment. Example: Thank you for your payment!
sendNotificationsToEmail
string
The email address to send notifications to. Example: notify@example.com
extraInformation
array[string]
Additional information fields.

Responses

200 Successfully created a new payment page.
400 Bad request due to invalid input or missing parameters.

Expected Outcomes

200

Success example

Successfully created a new payment page.

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

Failure example

Bad request due to invalid input or missing parameters.

Representative Error 
{
  "status": "error",
  "message": "Invalid request payload. Check `planId` and try again.",
  "errors": {
    "planId": [
      "`planId` 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",
}
data = {
  "planId": 456,
  "pageType": "Subscription",
  "pageName": "My Payment Page",
  "pageDescription": "This is a sample payment page."
}
files = {
    "seoImage": open("path/to/file.pdf", "rb")
}

response = requests.post(
    "https://api.paymish.com/api/payment-service/external/v1/payment-pages/create-pages",
    headers=headers,
    data=data,
    files=files,
)

print(response.json())
Node.js 
const axios = require("axios");
const fs = require("fs");
const FormData = require("form-data");

const formData = new FormData();
formData.append("planId", 456);
formData.append("pageType", "Subscription");
formData.append("pageName", "My Payment Page");
formData.append("pageDescription", "This is a sample payment page.");
formData.append("seoImage", fs.createReadStream("path/to/file.pdf"));

const response = await axios({
  method: "post",
  url: "https://api.paymish.com/api/payment-service/external/v1/payment-pages/create-pages",
  headers: {
    ...formData.getHeaders(),
    Authorization: "Bearer YOUR_SECRET_KEY",
  },
  data: formData
});

console.log(response.data);
cURL 
curl https://api.paymish.com/api/payment-service/external/v1/payment-pages/create-pages \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -F "planId=456"\
  -F "pageType=Subscription"\
  -F "pageName=My Payment Page"\
  -F "pageDescription=This is a sample payment page."\
  -F "seoImage=@path/to/file.pdf"
PHP 
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/payment-service/external/v1/payment-pages/create-pages");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
]); 
curl_setopt($ch, CURLOPT_POSTFIELDS, [
    "planId" => 456,
    "pageType" => "Subscription",
    "pageName" => "My Payment Page",
    "pageDescription" => "This is a sample payment page.",
    "seoImage" => new CURLFile("path/to/file.pdf"),
]);

$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
Previous endpoint Check if a custom link exists. Next endpoint Get payment pages.