Skip to main content
Complete the following prerequisites and configuration to start using the SurePay Connector.

Prerequisites

Before you begin, make sure you meet the following requirements:
  • You have completed the steps in the Getting started.
  • You have an active contract with SurePay and have configured your accounts and credentials for SurePay services.

Configuration

To configure your connector, follow these steps:
  1. Set your APIM subscription key in the header as follows:
    • Key: api-key
    • Value: <your subscription key>
  2. Request that the Grand Central team set up a connection with SurePay, and provide the following details for OAuth token generation:
    • surepay-vop-authorization for the VoP Connector
    • surepay-cop-authorization for the CoP Connector
    • surepay-grant-type
    The authorization values for VoP and CoP are different.
  3. Configure the SurePay baseURL in the gc-applications-live repository in the connector’s values.yaml file for VoP or CoP integration:
    surepay.vop.baseUrl = //SUREPAY environment base URL for VoP
    surepay.cop.baseUrl = //SUREPAY environment base URL for CoP
    
  4. The following example shows the connector’s values.yaml file location:
    ├── iPaaS
    └── azure/runtimes
        ├── dev
        └── test
            └── values
                ├── gc-surepay
                  └── party-v2.values.yaml
    

Test your integration

To access the Party Reference Unified API, include your Grand Central subscription key in the request header. If you do not have a key, contact the Grand Central Support Team to have one provisioned.
KeyValue
api-key<your_subscription_key>
Test the API using the Postman Collection.

Troubleshooting

If your connector is not responding as expected, check these common scenarios.
Cause: The Grand Central gateway cannot establish a handshake with the SurePay endpoint. This typically indicates an upstream service outage at SurePay or a network routing failure.Solution: Verify the operational status of the SurePay environment with SurePay. If the service is operational, contact the GC Support team.
Cause: The request to SurePay exceeded the configured timeout threshold. This can occur during high load or network latency issues.Solution: Verify the operational status of the SurePay environment with SurePay. If the service is operational, contact the GC Support team to review timeout configurations.
Cause: The credentials provided during setup are incorrect.Solution: Verify your credentials with SurePay and contact the GC team to update the connection.
Cause: The number of incoming requests exceeded the defined threshold for your subscription tier. This response protects the stability of the Grand Central and partner infrastructure.Solution: Review your application’s request patterns to identify unexpected spikes. If you require higher throughput, contact the Grand Central team to request an adjustment to your APIM rate limit policy.

Need more help?

Contact support

Reach out to the Grand Central team for assistance with environment setup or rate limit increases.