Test Connection

Verify your API keys are valid and check available SafeSites before processing payments.

GET/api/v1/auth/test

Response

json

{
  "success": true,
  "data": {
    "authenticated": true,
    "groupId": "550e8400-e29b-41d4-a716-446655440000",
    "groupName": "My Store",
    "safeSites": [
      { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "name": "SafeSite US", "isActive": true },
      { "id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "name": "SafeSite EU", "isActive": true }
    ],
    "activeSafeSiteCount": 2,
    "message": "API keys valid. 2 SafeSite(s) ready for payments."
  }
}

Response Fields

Field	Description
`authenticated`	Always `true` on success
`groupId`	Your group's unique identifier (UUID)
`groupName`	Your group's display name
`safeSites`	List of configured SafeSites
`activeSafeSiteCount`	Number of active SafeSites
`message`	Human-readable status message

When to Use

Use this endpoint to:

Verify your API keys are correctly configured
Check that you have active SafeSites before accepting payments
Debug connection issues during integration

cURL Example

bash

curl -X GET https://pay.ultrapay.cc/api/v1/auth/test \
  -H "X-Public-Key: upp_your_public_key" \
  -H "X-Secret-Key: ups_your_secret_key"