Check if a custom link exists.

Paymish Docs

Paymish
Payment Pages

Endpoint Overview

POST /api/payment-service/external/v1/payment-pages/custom-link-check-exist Requires authentication

Purpose

Use this endpoint to check if a custom link exists. It belongs to the Payment Pages collection and is designed for backend integrations.

Request shape

0 parameters and 1 documented body field using application/json.

Implementation Guide

Recommended workflow

Authenticate first and inject a valid bearer token or secret key before calling the endpoint.

Validate the input data, identifiers, and account state in your application before making the request.

Send the POST request from your backend using the required headers and the expected content type (application/json).

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 1 documented body field.
Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Request Body

Content type: application/json

customLink required

string

The custom link to check for existence. Example: https://example.com/my-custom-link

Responses

200 Custom link check successful.

400 Bad request due to invalid input or missing parameters.

Expected Outcomes

Custom link check successful.

{
  "message": "Page custom link not match."
}

Bad request due to invalid input or missing parameters.

{
  "error": "Page custom link already exist."
}

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

import requests

headers = {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
}
payload = {
  "customLink": "https://example.com/my-custom-link"
}

response = requests.post(
    "https://api.paymish.com/api/payment-service/external/v1/payment-pages/custom-link-check-exist",
    headers=headers,
    json=payload,
)

data = response.json()
print(data)

const axios = require("axios");

const response = await axios({
  method: "post",
  url: "https://api.paymish.com/api/payment-service/external/v1/payment-pages/custom-link-check-exist",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "customLink": "https://example.com/my-custom-link"
}
});

console.log(response.data);

curl https://api.paymish.com/api/payment-service/external/v1/payment-pages/custom-link-check-exist \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "customLink": "https://example.com/my-custom-link" }'

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/payment-service/external/v1/payment-pages/custom-link-check-exist");
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([
    "customLink" => "https://example.com/my-custom-link",
]));

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

Previous endpoint Delete plan. Next endpoint Create a new payment page.