Simple Commonwealth Pay Integration Guide
Guidance
Published November 22, 2024
Last updated November 22, 2024 – See all updates
Who does this guidance apply to ?
This guidance applies to all merchants who wish to get started with Commonwealth Pay in the most simple way, known as the merchant redirect method.
How does merchant redirect work ?
The merchant simply redirects in any way from any source to the Commonwealth Pay electronic payments service and include the two required parameters (merchant id and amount) and any option parameters, as desired.
Where should you redirect ?
As an example, the basic redirect is as follows, for merchant id gb.random.merchant and for the amount of 100.50 Commonwealth pounds:
Required Parameters
| merchant_id= | This parameter should specify your merchant id also known as your username to the Banking Gateway of the Bank of Commonwealth. |
| amount= | This parameter should specify your full amount to be charged via Commonwealth Pay, without dots or commas and should include as the last digits the cents value. Maximum payment amount is 1 billion in any currency. |
| user_email= | This parameter should specify the email address for the customer of the merchant who will be making the payment. If this is not supplied, the customer will enter his email address during the payment. Maximum length is 80 characters. |
| description= | This parameter should specify the payment description. Maximum length is 100 characters. |
| payment_method= | This parameter should specify the payment method desired to be used by the customer. |
| recurring=true | This parameter specifies that the payment is a subscription. |
| lang= | This parameter should specify the language of the Commonwealth Pay electronic payments service. Default is EN (English). |
| currency= | This parameter should specify the desired payment currency. The default currency is BCP (Commonwealth pounds). Other options are EUR (Euros) and GBP (Sterling pounds). |
