Getting started
Account set-up, credentials and your first integration steps.
Developers
Developers & integrations
Resources to connect BNYPay to your website, app or back office: from getting started to handling payment updates securely.
Documentation areas
What developer documentation covers
These areas are being confirmed against BNYPay's actual documentation. Each one is marked until it is.
Documentation status.
The developer portal at dev.bnypay.in (external site) is linked from the current BNYPay website, but its contents could not be verified during this build. The current website also mentions WordPress and Shopify plugins — pending confirmation.
API reference
Endpoints, request and response formats, and authentication.
Integration guides
Step-by-step guides for common integration scenarios.
Sandbox / test environment
Testing your integration without moving real money.
SDKs & plugins
Libraries and e-commerce platform plugins.
Webhooks
Receiving payment status updates in your system.
Error handling & FAQs
Error codes, retries and common questions.
Security guidelines
Protecting credentials and verifying notifications.
How it typically works
A generic online payment integration flow
This is a common pattern across payment providers, shown for orientation. It is not BNYPay-specific documentation.
Create a payment
Your server creates a payment or order for the amount the customer owes.
Customer pays
The customer completes payment using a method they choose.
Receive the update
Your system is told the result and checks the notification is authentic.
Fulfil and reconcile
You confirm the status server-side, fulfil the order and reconcile.
Illustration
What an integration looks like in code
The example on this page is pseudo-code that shows the shape of a typical integration. It does not use BNYPay's real API names, endpoints or credentials.
Visit the developer portal (external site)// Illustrative pseudo-code — not BNYPay's actual API.
// See the developer portal for real endpoints.
order = createOrder(amount, currency, "INV-2291")
redirectToCheckout(order)
on paymentUpdate(event):
if isAuthentic(event):
updateOrder(event.reference, event.status)
else:
reject(event) Pseudo-code · generic pattern
Integration security
Keep your integration secure
General good practice — not BNYPay-specific documentation. Follow BNYPay's security guidelines once published.
Keep API keys server-side
Never put secret keys in browser or mobile app code, and never commit them to code repositories.
Use HTTPS everywhere
Serve checkout pages and receive notifications only over HTTPS.
Verify notifications
Check that a payment notification is authentic before acting on it.
Reconcile server-side
Confirm payment status with a server-side check before fulfilling orders.
Restrict and rotate credentials
Limit who can access credentials, and rotate them regularly or after any suspected exposure.
Log safely
Keep useful logs, but never store full card numbers or other sensitive payment data.
Planning an integration?
Tell us what you are building and which BNYPay solutions you need. Our team can help you choose an integration approach.