Responses (Payment API)

Owned by Helen Griffith
Last updated: Mar 16, 2022

All requests to the Payment API endpoints return standard HTTP headers, including the response status code, and a response body in JSON format.

Success response code and parameters

Successful requests return a 200 Success code with a JSON object in the response body.

Response codes and errors

  • {"error":"invalid_client"} This error message indicates that the Vonage Contact Center (VCC) API credentials are invalid. Double check that the client ID and client secret generated in the API Admin application, or provided to you by your VCC administrator, are correct.

  • Provider's authorization endpoint returned error message 'invalid_client_key' This error indicates a configuration problem in the VCC account; the PCI provider rejected the request from VCC due to invalid client credentials. Contact VCC support or professional services to double check and update the credentials in your account.

  • Account configuration does not exists for account: {account}, configuration Id: {id}. This error indicates that the accountConfigurationId contained an invalid value. Double check that the value in accountConfigurationId matches one of the IDs that Vonage has supplied to you.

  • Provider's authorization endpoint returned error message 'invalid_client'/'invalid_client' for account name: {account}, configuration id: {id} This error may indicate a permissions issue on the PCI server side and typically requires PCI provider to ensure that the API user that VCC uses to connect has been set up with the correct permissions and is authorized to start PCI sessions.

  • Refused to display '{PCI Pal IFrame URL}' in a frame because it set 'X-Frame-Options' to 'deny'. This error message in the browser console typically means that the PCI provider (in this case PCI Pal) session has expired. To correct this, try starting another session ensuring that the iframe form action is directed to the URL for the new PCI payment session. You must also update the X-BEARER-TOKEN and X-REFRESH-TOKEN with the values for the new PCI payment session.