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

Update page details.

Topics

Endpoint Overview

Payment Pages

Update page details.

Update the details of an existing payment page.

PUT /api/payment-service/external/v1/payment-pages/update-page-details Requires authentication

Purpose

Use this endpoint to update page details. It belongs to the Payment Pages collection and is designed for backend integrations.

Request shape

0 parameters and 14 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 PUT 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 14 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

pageId
number
Unique identifier of the payment page to update. Example: 447
planId
number
ID of the subscription plan (if applicable). Example: 57
pageName
string
The name of the payment page. Example: Updated Payment Page
pageDescription
string
A brief description of the payment page. Example: This is an updated description of the payment page.
seoImage
string
SEO image file for the payment page.
isFixedPaymentAmount
string
Indicates if the payment amount is fixed (true/false). Example: true
fixedPaymentAmount
number
The fixed payment amount. Example: 150
isPhoneNumber
string
Indicates if the phone number is required (true/false). Example: false
customLink
string
The custom link for the payment page. Example: updated-custom-link
redirectAfterPaymentLink
string
The link to redirect to after payment. Example: https://example.com/redirect
sucessMessage
string
Message displayed after a successful payment. Example: Payment completed successfully.
sendNotificationsToEmail
string
Email address to send notifications. Example: notify@example.com
extraInformation
array[string]
Additional information fields. Example: ['Field1', 'Field2']
status
string
The status of the payment page (Published/Unpublished). Example: Published

Responses

200 Page details updated successfully.
400 Bad request due to invalid input or missing parameters.

Expected Outcomes

200

Success example

Page details updated successfully.

Representative Response 
{
  "message": "Page detail update successfully."
}
400

Failure example

Bad request due to invalid input or missing parameters.

Representative Error 
{
  "error": "Page detail not found!"
}
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 = {
  "pageId": 447,
  "planId": 57,
  "pageName": "Updated Payment Page",
  "pageDescription": "This is an updated description of the payment page."
}
files = {
    "seoImage": open("path/to/file.pdf", "rb")
}

response = requests.put(
    "https://api.paymish.com/api/payment-service/external/v1/payment-pages/update-page-details",
    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("pageId", 447);
formData.append("planId", 57);
formData.append("pageName", "Updated Payment Page");
formData.append("pageDescription", "This is an updated description of the payment page.");
formData.append("seoImage", fs.createReadStream("path/to/file.pdf"));

const response = await axios({
  method: "put",
  url: "https://api.paymish.com/api/payment-service/external/v1/payment-pages/update-page-details",
  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/update-page-details \
  -X PUT \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -F "pageId=447"\
  -F "planId=57"\
  -F "pageName=Updated Payment Page"\
  -F "pageDescription=This is an updated description of the 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/update-page-details");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
]); 
curl_setopt($ch, CURLOPT_POSTFIELDS, [
    "pageId" => 447,
    "planId" => 57,
    "pageName" => "Updated Payment Page",
    "pageDescription" => "This is an updated description of the payment page.",
    "seoImage" => new CURLFile("path/to/file.pdf"),
]);

$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
Previous endpoint Get payment page details. Next endpoint Update page status .