How to implement and test the Payment API

Separate Vonage Contact Center (VCC) accounts (Sandbox and Production)

If you have multiple VCC accounts including a dedicated sandbox (pre-production or development) account, you can develop and test your API integration without making any changes to your production (live) account. If you have a single VCC account, go to Single VCC account later in this page.

When implementing the API, you need to make sure it is configurable. This is because it will require separate API client credentials to operate against the separate VCC accounts. While VCC will try to keep the accountConfigurationId values consistent across your different VCC accounts, the configuration IDs might be different in the sandbox and production accounts.

The following diagram shows the setup and links between the VCC accounts and account configurations, and the PCI payment provider environments and payment flows. In this example setup, there are two “payment flows” (‘Flow 695’ and ‘Flow 696’) on the PCI payment provider staging service. The flows are launched using the corresponding accountConfigurationId (‘1’ and ‘2’ respectively) configured in the VCC sandbox account. When the project transitions into production, the flows are promoted to the production PCI payment provider node (and now have different flow numbers) and the production VCC account links to these production flows.

In the example, you open a payment session on the sandbox VCC account that starts ‘Flow 695’ on the PCI payment provider staging node using API credentials ‘A’ and accountConfigurationId ‘1’. Conversely, using API credentials ‘B’ and accountConfigurationId ‘1’, you open a PCI session on the production VCC account that launches ‘Flow 422’ on the PCI payment provider production node.

Single VCC account

If you have a single VCC account, you will develop and test the API integration in the single account. You can develop and test using staging payment flows so that you don’t affect the payment system in production.

You can use a single API client ID, alternatively you may use separate API client IDs if you want the option to disable the staging credentials.

When implementing the API, you need to make sure your integration is configurable. This will enable you to specify the accountConfigurationId you want to trigger when you test your integration using the staging flows before switching to production flows.

The following diagram shows the setup and links between the single VCC account and account configurations, and the staging and production PCI payment provider environment and payment flows. In this example setup, there are two payment flows (‘Flow 695’ and ‘Flow 696’) on the PCI payment provider staging service. These flows are launched using the corresponding accountConfigurationId (‘1’ and ‘2’ respectively) configured in the VCC account. As the project transitions into production, the flows are promoted to the production PCI payment provider node (and now have different flow numbers) and Vonage then configures the VCC account to link to these production flows which results in accountConfigurationId ‘4’ and ‘5’.

Using the API credentials ‘A’ to start a payment session, accountConfigurationId ‘1’ opens a PCI session on the VCC account that launches ‘Flow 695’ on the PCI payment provider staging node. Using these same API credentials to start a payment session with accountConfigurationId ‘4’ opens a PCI session on the VCC account that launches ‘Flow 422’ on the PCI payment provider production node. Optionally, you may consider creating a second API credential set ‘B’ to maintain a separate client credential set for your API client, however both credential sets would work on the single VCC account and would be able to start staging or production flows.