After reading through this guide, check out the API Reference to see all available API requests, and use the Explorer to test calls in real-time with your own data.
To start using the Payment API you must have completed the following tasks:
- Sign up for a Vonage Contact Center (VCC) account. Find more information about how to do this at Vonage | Cloud Contact Center.
- Set up a working interaction plan in which interactions are delivered to your agents through an Automatic Call Distributor or Universal Contact Distributor. For information about setting up interactions plans and using VCC to make and receive interactions, go to Vonage Contact Center Product Documentation.
- Request your client credentials from the VCC Admin Portal and use these credentials to get a bearer access token. You must use your bearer access token to send requests to the Payment API. For information about using your client credentials to get a bearer access token, see Authentication for Vonage Contact Center APIs (using the new API gateway).
- Contact your account manager and request the GlobalPCI feature for your account.
The root URL for the Payment API is https://***.api.newvoicemedia.com/globalpci, where *** represents a regional subdomain. URLs in the example code use *** in place of the region.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Add the resource name to the URL to form the endpoint you need to access the resource and its fields. For example, https://***.api.newvoicemedia.com/globalpci/v1/session/ provides access to the session resource and its fields.