Single Payment Widget
Our Single Payment Widget can be embedded within a checkout journey to support Open Banking payments direct from UK bank accounts as an alternative to card payment solutions. It can support one or many end payees.
Create a Payment Widget
Create a new widget and select Single Payment Widget as the widget type. Start by filling out the general fields:
| Name | Description | Requirement |
|---|---|---|
| Widget Name | Used to identify the widget in Moneyhub admin portal only. | Required |
| Business | The API Business the logged on user is linked to (one or many). API Business name is initially set by Moneyhub. You can create many different widgets under your API business. | Required |
| Widget Status | Can be either Production or Sandbox. This dictates whether live banks or test banks are accessible during the payment flow. Note: the status cannot be changed after creation, a new widget would need to be created. | Required |
| Authorised Domains | If you choose to host the widget yourself, specify a list of domains on which it can be hosted. | Optional |
An example could look like:
A payment widget requires a payee account that will receive the money. You need to supply valid UK bank account details for the payment to be sent to.
| Name | Description | Requirement |
|---|---|---|
| Display Name | Can differ from the actual bank account name to support aliasing | Optional |
| Account Name | Used when instructing the payment | Required |
| Account Number | Valid UK bank account number | Required |
| Sort Code | Valid UK sort code | Require |
Furthermore, you need to specify the default payment details.
| Name | Description | Requirement |
|---|---|---|
| Amount | A default amount that the end user is expected to pay. | Required |
| Reference | A payment reference can be specified, which will be the same for every payment, or it can be left blank to generate a unique reference code for each payment. | Optional |
An example could look like:
After a widget is created, the default values can be overwritten by passing in query params during widget instantiation. These include:
| Name | Description |
|---|---|
| payeeId | Once a widget is created a unique Payee ID is associated to each payee created. You can change which payee the widget will use here. |
| amount | For example: basket / checkout amount |
| reference | For example: invoice ID, vendor name |
| endToEndId | Unique ID, for example: customer ID, session ID, invoice ID |
Preview Widget
Once a Widget has been created it can be Previewed via the top menu bar, see Preview
Example Payment Widget Journey
Updated 13 days ago