Paymish Docs
API Reference
- Paymish
- API Reference
API Reference
Explore every available Paymish endpoint by collection
194 endpoints across 23 resources. Open any endpoint to inspect parameters, request bodies, authentication needs, and multi-language code examples.
What you get
Structured parameters, request and response metadata, sample payloads, and code examples for supported endpoints.
Best way to use it
Start with the collection closest to your workflow, then drill into a single endpoint page for implementation details.
Authenticate partner systems and exchange credentials for the tokens or secure access values required for subsequent API calls.
The Banks collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
The Business collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
The Customer collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
POST
/api/customer-service/external/v1/create
Create customer
PUT
/api/customer-service/external/v1/customer-update
Update customer
GET
/api/customer-service/external/v1/list
Get customer list
PUT
/api/customer-service/external/v1/black-listed
Blacklist or whitelist a customer
GET
/api/customer-service/external/v1/get-customer-by-id
Get customer details by ID
POST
/api/customer-service/v1/create
Create customer
PUT
/api/customer-service/v1/customer-update
Update customer
GET
/api/customer-service/v1/list
Get customer list
PUT
/api/customer-service/v1/black-listed
Blacklist or whitelist a customer
GET
/api/customer-service/v1/get-customer-by-id
Get customer details by ID
The Customers collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
The Dedicated Virtual Accounts collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
POST
/api/transaction-service/external/v1/dedicated-virtual-accounts
Create a Dedicated Virtual Account
GET
/api/transaction-service/external/v1/dedicated-virtual-accounts
List Dedicated Virtual Accounts
GET
/api/transaction-service/external/v1/dedicated-virtual-accounts/{customerId}
Get Dedicated Virtual Account Details
PUT
/api/transaction-service/external/v1/dedicated-virtual-accounts/{customerId}
Update Dedicated Virtual Account
GET
/api/transaction-service/external/v1/dedicated-virtual-accounts/requery
Requery Dedicated Virtual Account
POST
/api/transaction-service/external/v1/dedicated-virtual-accounts/assign
Assign Dedicated Virtual Account
Manage dispute lifecycles, including creating a dispute, checking its status, and updating the supporting evidence or dispute details.
POST
/api/dispute-service/external/v1/create-dispute
Create a dispute by uploading a document.
GET
/api/dispute-service/external/v1/list
Retrieve a list of disputes.
GET
/api/dispute-service/external/v1/dispute-details
Retrieve dispute details by transaction reference.
PUT
/api/dispute-service/external/v1/update-dispute
Update a dispute.
The Disputes collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
The Initialize Checkout collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
The Invoices collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
Create hosted payment pages, manage their lifecycle, and attach products or custom payment settings.
POST
/api/payment-service/external/v1/payment-pages/custom-link-check-exist
Check if a custom link exists.
POST
/api/payment-service/external/v1/payment-pages/create-pages
Create a new payment page.
GET
/api/payment-service/external/v1/payment-pages/get-pages
Get payment pages.
GET
/api/payment-service/external/v1/payment-pages/get-page-details
Get payment page details.
PUT
/api/payment-service/external/v1/payment-pages/update-page-details
Update page details.
PUT
/api/payment-service/external/v1/payment-pages/update-page-status
Update page status .
POST
/api/payment-service/external/v1/payment-pages/delete-page
Delete page.
GET
/api/payment-service/external/v1/payment-pages/payment-page-get-product
Retrieve products associated with a payment page.
POST
/api/payment-service/external/v1/payment-pages/payment-page-add-product
Add products to a payment page.
POST
/api/payment-service/external/v1/payment-pages/payment-page-delete-product
Delete a product from a payment page.
POST
/api/payment-service/v1/payment-pages/custom-link-check-exist
Check if a custom link exists.
POST
/api/payment-service/external/v1/payment-pages/initiate-initialize-checkout-dynamic-virtual-account
Initiate a dynamic virtual account for a checkout session.
GET
/api/payment-service/v1/payment-pages/get-pages
Get payment pages.
GET
/api/payment-service/v1/payment-pages/get-page-details
Get payment page details.
PUT
/api/payment-service/v1/payment-pages/update-page-details
Update page details.
PUT
/api/payment-service/v1/payment-pages/update-page-status
Update page status .
POST
/api/payment-service/v1/payment-pages/delete-page
Delete page.
GET
/api/payment-service/v1/payment-pages/payment-page-get-product
Retrieve products associated with a payment page.
POST
/api/payment-service/v1/payment-pages/payment-page-add-product
Add products to a payment page.
POST
/api/payment-service/v1/payment-pages/payment-page-delete-product
Delete a product from a payment page.
GET
/api/transaction-service/external/v1/payment-pages
List payment pages
POST
/api/transaction-service/external/v1/payment-pages
Create payment page
Create and maintain reusable billing plans that power recurring payment flows.
POST
/api/payment-service/external/v1/plans/create-plan
Create New Plan
GET
/api/payment-service/external/v1/plans/get-plans
Get payment plans
GET
/api/payment-service/external/v1/plans/get-plan-details
Get plan details
PUT
/api/payment-service/external/v1/plans/update-plan-details
Update plan details
POST
/api/payment-service/external/v1/plans/delete-plan
Delete plan.
POST
/api/payment-service/v1/plans/create-plan
Create New Plan
GET
/api/payment-service/v1/plans/get-plans
Get payment plans
GET
/api/payment-service/v1/plans/get-plan-details
Get plan details
PUT
/api/payment-service/v1/plans/update-plan-details
Update plan details
POST
/api/payment-service/v1/plans/delete-plan
Delete plan.
GET
/api/transaction-service/external/v1/plans
List plans
POST
/api/transaction-service/external/v1/plans
Create plan
The Products collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
POST
/api/payment-service/external/v1/products/create-product
Create New Product
GET
/api/payment-service/external/v1/products/get-products
Get payment products
GET
/api/payment-service/external/v1/products/get-product-details
Get product detail
POST
/api/payment-service/external/v1/products/delete-product
Delete product.
POST
/api/payment-service/external/v1/products/archive-product
Archive product.
PUT
/api/payment-service/external/v1/products/update-product-details
Update product details
POST
/api/payment-service/external/v1/products/product-upload-media
Upload media for a product
GET
/api/payment-service/external/v1/products/get-product-media
Get product media
POST
/api/payment-service/external/v1/products/delete-product-media
Delete product media.
GET
/api/payment-service/external/v1/products/get-product-inventory-details
Get product inventory details
POST
/api/payment-service/external/v1/products/add-digital-download-files
Upload file for digital download
GET
/api/payment-service/external/v1/products/get-digital-download-files
Get digital download files
PUT
/api/payment-service/external/v1/products/rename-digital-download-files
Rename digital download files
POST
/api/payment-service/external/v1/products/delete-digital-download-files
Delete product variant media.
PUT
/api/payment-service/external/v1/products/set-download-link-expiry
Set download link expiry
POST
/api/payment-service/external/v1/products/add-delivery-fees
Add delivery fees
GET
/api/payment-service/external/v1/products/get-delivery-fees
Get delivery fees
PUT
/api/payment-service/external/v1/products/update-delivery-fees
Update delivery fees
POST
/api/payment-service/external/v1/products/delete-delivery-fees
Delete delivery fees.
POST
/api/payment-service/external/v1/products/slugExist
product slug check exist.
POST
/api/payment-service/external/v1/products/add-discount-code
Create New Discount Code.
GET
/api/payment-service/external/v1/products/get-discount-codes
get discount codes .
PUT
/api/payment-service/external/v1/products/update-discount-code-details
update product discount code details.
POST
/api/payment-service/external/v1/products/verify-discount-code
get discount codes .
POST
/api/payment-service/v1/products/create-product
Create New Product
GET
/api/payment-service/v1/products/get-products
Get payment products
GET
/api/payment-service/v1/products/get-product-details
Get product detail
POST
/api/payment-service/v1/products/delete-product
Delete product.
POST
/api/payment-service/v1/products/archive-product
Archive product.
PUT
/api/payment-service/v1/products/update-product-details
Update product details
POST
/api/payment-service/v1/products/product-upload-media
Upload media for a product
GET
/api/payment-service/v1/products/get-product-media
Get product media
POST
/api/payment-service/v1/products/delete-product-media
Delete product media.
POST
/api/payment-service/v1/products/add-product-options
Add Product Options.
PUT
/api/payment-service/v1/products/update-product-option-details
update product option details.
POST
/api/payment-service/v1/products/delete-product-options
Delete product options.
POST
/api/payment-service/v1/products/add-product-option-variant
Add product option variant.
PUT
/api/payment-service/v1/products/update-product-option-variant
update product option variant.
POST
/api/payment-service/v1/products/delete-product-option-variant
Delete product option variant.
GET
/api/payment-service/v1/products/filter-for-products-variant
filter for product variant .
GET
/api/payment-service/v1/products/get-product-inventory-details
Get product inventory details
PUT
/api/payment-service/v1/products/update-product-variant-details
update product variant details.
POST
/api/payment-service/v1/products/add-product-variant-media
Upload media in product variant.
GET
/api/payment-service/v1/products/get-product-variant-media
get product variant media.
POST
/api/payment-service/v1/products/delete-product-variant-media
Delete product variant media.
POST
/api/payment-service/v1/products/add-digital-download-files
Upload file for digital download
GET
/api/payment-service/v1/products/get-digital-download-files
Get digital download files
PUT
/api/payment-service/v1/products/rename-digital-download-files
Rename digital download files
POST
/api/payment-service/v1/products/delete-digital-download-files
Delete product variant media.
PUT
/api/payment-service/v1/products/set-download-link-expiry
Set download link expiry
POST
/api/payment-service/v1/products/add-delivery-fees
Add delivery fees
GET
/api/payment-service/v1/products/get-delivery-fees
Get delivery fees
PUT
/api/payment-service/v1/products/update-delivery-fees
Update delivery fees
POST
/api/payment-service/v1/products/delete-delivery-fees
Delete delivery fees.
POST
/api/payment-service/v1/products/duplicate-product
duplicate product.
POST
/api/payment-service/v1/products/slugExist
product slug check exist.
POST
/api/payment-service/v1/products/add-discount-code
Create New Discount Code.
GET
/api/payment-service/v1/products/get-discount-codes
get discount codes .
PUT
/api/payment-service/v1/products/update-discount-code-details
update product discount code details.
Manage payout recipients that can be reused across transfer flows.
GET
/api/transaction-service/external/v1/transfer/get-recipient-list
Retrieve a list of recipients
GET
/api/transaction-service/external/v1/transfer/get-recipient-details
Retrieve details of a specific recipient
DELETE
/api/transaction-service/external/v1/transfer/recipient
Delete a recipient
POST
/api/transaction-service/external/v1/transfer/blacklist-recipient
Blacklist a recipient
The SplitPages collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
POST
/api/transaction-service/external/v1/split-page
Create a new split page
GET
/api/transaction-service/external/v1/split-page/all
Returns the list of all split pages
GET
/api/transaction-service/external/v1/split-page/{id}
Get a split page by id
PUT
/api/transaction-service/external/v1/split-page/{id}
Update a split page by ID
DELETE
/api/transaction-service/external/v1/split-page/{id}
Remove a split page by ID
POST
/api/transaction-service/external/v1/split-page/{id}/subaccount/add
Add a subaccount to a split page
PUT
/api/transaction-service/external/v1/split-page/{id}/subaccount/update
Update a subaccount in a split page
DELETE
/api/transaction-service/external/v1/split-page/{id}/subaccount/delete
Delete a subaccount from a split page
The Subaccounts collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
POST
/api/transaction-service/external/v1/subaccounts/
Create a new subaccount
GET
/api/transaction-service/external/v1/subaccounts/all
Get all subaccounts
GET
/api/transaction-service/external/v1/subaccounts/{id}
Get a subaccount by ID
PUT
/api/transaction-service/external/v1/subaccounts/{id}
Update a subaccount by ID
DELETE
/api/transaction-service/external/v1/subaccounts/{id}
Delete a subaccount by ID
Create and manage recurring billing subscriptions connected to plans and customer payment methods.
GET
/api/payment-service/external/v1/subscription/all
Retrieve a list of subscriptions
POST
/api/payment-service/external/v1/subscription
Create a new subscription
GET
/api/payment-service/external/v1/subscription/{id}
Get a subscription by ID
PUT
/api/payment-service/external/v1/subscription/{id}
Update a subscription
DELETE
/api/payment-service/external/v1/subscription/{id}
Delete a subscription
The Transaction collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
GET
/api/transaction-service/external/v1/list
Get document.
POST
/api/transaction-service/external/v1/transaction-with-card
Transaction with Card.
POST
/api/transaction-service/external/v1/transaction-with-ndd
Create a transaction with NDD
POST
/api/transaction-service/external/v1/transaction-with-qr
Initiate a transaction with QR code.
GET
/api/transaction-service/external/v1/bank-list
Retrieve the list of banks
POST
/api/transaction-service/external/v1/transaction-with-bank
Create a transaction with a bank
POST
/api/transaction-service/external/v1/bank-verify
Verify bank details
POST
/api/transaction-service/external/v1/transaction-with-ussd
Create a transaction with USSD
POST
/api/transaction-service/external/v1/transaction-with-ussd-verify
Verify a transaction with USSD
POST
/api/transaction-service/external/v1/refund-transaction
Refund a transaction
GET
/api/transaction-service/external/v1/refund-list
Get refund list
GET
/api/transaction-service/external/v1/refund-details
Get refund details with transaction reference or refund ID
GET
/api/transaction-service/external/v1/refund-by-reference
Get refund details by reference
POST
/api/transaction-service/external/v1/verify-account
refund card transaction.
GET
/api/transaction-service/external/v1/debit-accounts
Get debit accounts with balances
GET
/api/transaction-service/external/v1/scheduled-transactions
Get scheduled transactions
The Transactions collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
GET
/api/transaction-service/external/v1/verify/{reference}
Verify Transaction
GET
/api/transaction-service/external/v1/listStatistics
Transaction statistics
GET
/api/transaction-service/external/v1/csv-list
Export transactions (CSV)
GET
/api/transaction-service/external/v1/bank-list-payplus
List PayPlus banks
GET
/api/transaction-service/external/v1/fetch/{id}
Fetch Transaction
Move funds programmatically, inspect balances, retrieve transfer details, and manage transfer execution flows.
GET
/api/transaction-service/external/v1/transfer/all-banks
Retrieve the list of banks.
POST
/api/transaction-service/external/v1/transfer/create-single-transfer
Initiate a single transfer to a user.
GET
/api/transaction-service/external/v1/transfer/get-transfer-list
Retrieve a list of transfers.
GET
/api/transaction-service/external/v1/transfer/balance
Retrieve the balance.
GET
/api/transaction-service/external/v1/transfer/transfer-details
Retrieve transfer details.
POST
/api/transaction-service/external/v1/transfer/submit-bulk-transfer
Submit Bulk Transfer
The Transfers collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
The Utility collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
GET
/api/payment-service/external/v1/utility/biller-groups
Fetch Biller Groups
GET
/api/payment-service/external/v1/utility/billers/group/{groupId}
Fetch Billers by Group ID
GET
/api/payment-service/external/v1/utility/packages/biller/{billerId}
Fetch Packages by Biller ID
POST
/api/payment-service/external/v1/utility/transactions/customer-lookup
Customer Lookup
POST
/api/payment-service/external/v1/utility/transactions/process-payment
Process Payment
GET
/api/payment-service/external/v1/utility/transactions/payment-lookup
Payment Lookup
The Virtual Accounts collection groups related Paymish operations so developers can implement the full workflow for this business domain from one place.
GET
/api/transaction-service/external/v1/virtual-accounts
List virtual accounts
POST
/api/transaction-service/external/v1/virtual-accounts
Create virtual account
GET
/api/transaction-service/external/v1/virtual-accounts/{id}
Get virtual account
PUT
/api/transaction-service/external/v1/virtual-accounts/{id}
Update virtual account