PayPal

PayPal is a globally recognised online payment platform that enables users to shop online and in person, make payments, and send and receive money. Users can connect multiple funding sources to their PayPal wallet, including credit cards, debit cards, and bank accounts.

📘
Scope of This Integration
The BR-DGE PayPal integration covers the PayPal wallet payment instrument only. Card payments features available through PayPal's broader suite are not supported via this integration.

What You Can Do

Operation	Description
Create a PayPal Order	Initiate a payment session and receive a redirect URL for customer approval
Authorise a Payment	Reserve funds on a customer's PayPal account
Capture a Payment	Settle a payment immediately or after a prior authorisation
Retrieve an Order	Check the current status of any PayPal order
Refund a Payment	Return funds to a customer
Void an Authorisation	Cancel a reserved but uncaptured payment
Vault a Wallet	Save a customer's PayPal wallet for future payments
Send a Payout	Send money directly to a PayPal account

Getting Started

BR-DGE acts as a PayPal partner, managing all API requests to PayPal on your behalf. Before you can process PayPal payments, you need to have PayPal enabled on your BR-DGE retail channel.

Contact BR-DGE Support to get onboarded.

Integration Approaches

API Integration

You control the entire checkout experience. Your server communicates directly with BR-DGE to create and manage PayPal orders, while your frontend handles customer redirection.

Best for: Merchants who need full control over the checkout UI and payment flow.

Flow:

Customer selects PayPal at checkout
Your server creates a PayPal order via BR-DGE and receives a redirectUrl
The customer is redirected to PayPal to log in and approve the payment
Your frontend receives the onApprove() confirmation event
Your server calls BR-DGE to authorise or capture the payment
Customer is redirected to your order confirmation page

Hosted Payment Page (HPP)

BR-DGE manages the complete PayPal flow within a branded hosted checkout interface. You generate an HPP URL and redirect your customer — BR-DGE handles the rest.

Best for: Merchants who want a simpler integration with minimal frontend development.

Flow:

Customer selects products and proceeds to checkout
Your server generates an HPP URL including customer and order data
Customer is redirected to the BR-DGE Hosted Payment Page
Customer selects PayPal and approves via a secure pop-up
HPP authorises or captures the payment based on your intent configuration
Customer is redirected to your return URL

Related Guides

PayPal Payments — Full payment lifecycle: create, authorise, capture, refund, void
PayPal Vault — Save and reuse customer PayPal wallets
PayPal Payouts — Send outbound payments to PayPal accounts
PayPal Notifications — Receive real-time event updates