Our REST API is designed to provide you with a single integration into the BR-DGE payment marketplace, unlocking access to a wide range of third-party payment services, including Payment Service Providers, Digital Wallets, Alternative Payment Methods, and other related services.
Please see our dedicated WebSDK or Hosted Payment Page documentation for more information about how we can help you integrate your client applications with us.
You can see our OpenAPI Specification by going to the BR-DGE REST API OpenAPI specification.
Authorization
API keys can be generated directly in the BR-DGE portal, and are grouped into two types, based on how they will be used:
| Type | Description |
|---|---|
| Server | Used by your secure back-end server to create & manage transactions - Not for use in client applications |
| Client | Used by client applications to support operations in untrusted client environments. Such as tokenising card data |
Your server API key can be used to directly manage transactions. It should never be exposed to your client applications.
Environment Sub Domains
The BR-DGE REST API is hosted on two subdomains, one for testing and one for live payments.
https://sandbox.comcarde.com
https://secure.comcarde.com
If you have your own dedicated BR-DGE environment your subdomain will be different to the domains listed above. Please contact our support team if you are unsure which domain to use.
IMPORTANT To ensure PCI Compliance please only use mock payment instrument data when interacting with our Sandbox API.