Skip to main content
Search

01-Health Check

  • This test case validates that your callback server is operational and can respond to basic health check requests.
  • GTR will send a simple health check callback (callbackType=0) to verify your server's availability.
  • This should be the first test run before any complex Travel Rule scenarios.

GTR Request (GTR → VASP)​

  • Method: POST
  • Your Callback Endpoint: https://[YOUR_CALLBACK_URL]
  • Authentication:
    • mTLS (Mutual Transport Layer Security) - GTR will authenticate using client certificates
  • Header:
    • Content-Type: application/json
  • Body:
{
    "requestId": "test-[RANDOM_ID]",
    "invokeVaspCode": "[YOUR_VASP_CODE]",
    "originatorVasp": "[YOUR_VASP_CODE]",
    "beneficiaryVasp": "[YOUR_VASP_CODE]",
    "callbackType": 0,
    "callbackData": {}
}
curl -v --location --request POST 'https://[YOUR_CALLBACK_URL]' \
    -k \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "requestId": "test-abc123def456",
        "invokeVaspCode": "[YOUR_VASP_CODE]",
        "originatorVasp": "[YOUR_VASP_CODE]",
        "beneficiaryVasp": "[YOUR_VASP_CODE]",
        "callbackType": 0,
        "callbackData": {}
    }'

Hint:

  • callbackType: 0 indicates a health check request
  • Empty callbackData means no additional processing is required
  • Your server should respond within 30 seconds

Materials:

Expected Response (VASP → GTR)​

When your callback server is operational, you should return:

  • HTTP Status Code: 200
  • verifyStatus: 100000 (success)
{
    "verifyStatus": 100000,
    "verifyMessage": "Health check passed"
}

Test Validation​

Success Criteria:​

  • ✅ HTTP status code 200 returned
  • ✅ Response received within 30 seconds
  • ✅ verifyStatus: 100000 indicates successful health check
  • ✅ Valid JSON response format

Common Issues:​

  • ⚠️ Server Unavailable: Check if your callback server is running on the correct port
  • ⚠️ SSL/TLS Issues: Ensure your server accepts mTLS connections
  • ⚠️ Response Format: Must return proper JSON with verifyStatus and verifyMessage
  • ⚠️ Timeout: Server must respond within the timeout period