With our Customer Vault embedded hosted form functionality, you can achieve quick, efficient, and secure customer card tokenization without the worry of PCI compliance.The overall process to generate and prepare a hosted customer vault card form is as follows.1.
Create a POST request with the required parameters for your needs
2.
We will return the code of the hosted form and the URL in the response
3.
You can embed this form to collect customer card data in your vault securely.
| Fields | Description | Type | Required |
|---|
| dba | Dba Object | Object | Yes |
| dba.id | DBA ID | Integer | Yes |
| terminal | Terminal Object | Object | Yes |
| terminal.id | Terminal ID | Integer | Yes |
| customerVault | Customer Vault Object | Object | No |
| customerVault.id | The id of the Customer in the Customer Vault | Integer | No |
| returnUrl | The return URL after payment completion (i.e success/error page) | String | No |
| returnUrlNavigation | How to redirect the URL (Inside/Outside of frame) top or self | ENUM | No |
IMPORTANT If you do not supply customerVault.id , the generated code that we supply will include two additional parameters customerVaultId and customerVaultToken which you will need to dynamically provide when you are embeding the code. This information is needed to identify the correct customer in your Customer Vault.
In the return URL we will pass the Customer ID and Card ID as well as the status. The parameters that we have are: Success and Cancelled Modified at 2025-08-09 05:39:42