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:-
Set your APIM subscription key in the header as follows:
- Key:
api-key - Value:
<your subscription key>
- Key:
-
Request that the Grand Central team set up a connection with SurePay, and provide the following details for OAuth token generation:
surepay-vop-authorizationfor the VoP Connectorsurepay-cop-authorizationfor the CoP Connectorsurepay-grant-type
The authorization values for VoP and CoP are different. -
Configure the SurePay
baseURLin thegc-applications-liverepository in the connector’svalues.yamlfile for VoP or CoP integration: -
The following example shows the connector’s
values.yamlfile location:
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.| Key | Value |
|---|---|
api-key | <your_subscription_key> |
Troubleshooting
If your connector is not responding as expected, check these common scenarios.5xx: Internal server error or core system down
5xx: Internal server error or core system down
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.
5xx: Timeout or SocketTimeoutException
5xx: Timeout or SocketTimeoutException
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.
Invalid authentication
Invalid authentication
Cause: The credentials provided during setup are incorrect.Solution: Verify your credentials with SurePay and contact the GC team to update the connection.
429: Rate limit exceeded
429: Rate limit exceeded
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.