Build real Paymish integrations with API Auth, Transfer, Dispute, and Payment Pages
Start with API Auth for secure access, then move into Transfer and the rest of the live Paymish collections. The documentation currently covers 194 endpoints across 23 API groups.
- Recommended starting point: API Auth with 1 endpoint
- Next implementation flow: Transfer for the next core integration step
- Operational follow-up: Dispute for broader production workflows
Live API collections
23 collections currently available from the live Paymish schema.
Total endpoints
194 documented endpoints ready to explore.
API Auth
Authenticate partner systems and exchange credentials for the tokens or secure access values required for subsequent API calls.
1 endpoint Featured CollectionTransfer
Move funds programmatically, inspect balances, retrieve transfer details, and manage transfer execution flows.
6 endpoints Featured CollectionDispute
Manage dispute lifecycles, including creating a dispute, checking its status, and updating the supporting evidence or dispute details.
4 endpointsThese are the core Paymish flows most developers start with when building payments, transfers, disputes, and hosted payment experiences.
API Auth
Authenticate partner systems and exchange credentials for the tokens or secure access values required for subsequent API calls.
- Generate Token.
Transfer
Move funds programmatically, inspect balances, retrieve transfer details, and manage transfer execution flows.
- Retrieve the list of banks.
- Initiate a single transfer to a user.
- Retrieve a list of transfers.
Dispute
Manage dispute lifecycles, including creating a dispute, checking its status, and updating the supporting evidence or dispute details.
- Create a dispute by uploading a document.
- Retrieve a list of disputes.
- Retrieve dispute details by transaction reference.
Payment Pages
Create hosted payment pages, manage their lifecycle, and attach products or custom payment settings.
- Check if a custom link exists.
- Create a new payment page.
- Get payment pages.
Banks
The Banks collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
- List Banks
- Resolve Account Number
Start with the live collection that matches the workflow you want to implement first.
API Auth
Collect the required credentials from the Paymish Dashboard or integration setup.
Generate an access token before calling protected endpoints.
Transfer
Retrieve bank and recipient details before collecting final transfer instructions.
Initiate payouts to users or partner bank accounts.
Dispute
Capture the transaction reference and the business reason for the dispute.
Raise a dispute for a transaction with supporting files or notes.
Payment Pages
Create the payment page with branding, pricing, and any custom link requirements.
Generate payment links for product sales or campaigns.
Start with a real POST call from the API Auth collection. Use this request to generate token and confirm your integration flow.
curl https://api.paymish.com/api/user-service/external/v1/generate-token \
-X POST \
-H "Content-Type: application/json" \
-d '{ "public_key": "value", "secret_key": "value" }'
import requests
headers = {
"Content-Type": "application/json",
}
payload = {
"public_key": "value",
"secret_key": "value"
}
response = requests.post(
"https://api.paymish.com/api/user-service/external/v1/generate-token",
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/user-service/external/v1/generate-token",
headers: {
"Content-Type": "application/json",
},
data: {
"public_key": "value",
"secret_key": "value"
}
});
console.log(response.data);
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/user-service/external/v1/generate-token");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"public_key" => "value",
"secret_key" => "value",
]));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
Browse Paymish resources by category, then drill into each collection for the full implementation guide and endpoint details.
Getting Started
Start here for authentication, onboarding, customer setup, and the first transaction-building flows.
Payments
Core payment experiences, product-led billing, subscriptions, and transaction-facing collections.
Operations
Operational money movement and account configuration for payouts, recipients, and account structures.
Support
Collections that help operations and support teams investigate, recover, or manage edge cases.
More
Additional collections available from the live Paymish API schema.
API Auth Guide
Authenticate partner systems and exchange credentials for the tokens or secure access values required for subsequent API calls.
Transfer Workflow
Retrieve bank and recipient details before collecting final transfer instructions.
API Reference
Review every available collection, endpoint, parameter, and response from the live Paymish schema.
Dispute Implementation
Raise a dispute for a transaction with supporting files or notes.