Ping

The Ping endpoint allows you to test your API connection and verify that your authentication is working correctly.

Overview

Use the ping endpoint to:

Test your API key authentication

Verify API connectivity

Check API server status

Validate your integration setup

Endpoints

GET /v2/ping

Test API connectivity and authentication.

Authentication Required: Yes

Request

Response

Success Response (200 OK):

{
  "data": {
    "message": "pong",
    "timestamp": "2024-01-15T10:30:00.000Z",
    "version": "2.0.0"
  },
  "message": "API is working correctly"
}

Error Response (401 Unauthorized):

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  },
  "message": "Authentication failed"
}

Code Examples

JavaScript/Node.js

Python

PHP

Error Codes

Code	Description
200	Success - API is working correctly
401	Unauthorized - Invalid or missing API key
429	Rate limit exceeded
500	Internal server error

Best Practices

Use for Health Checks: Implement ping checks in your monitoring systems

Authentication Validation: Always test new API keys with ping before using other endpoints

Connection Testing: Use ping to verify network connectivity to the API

Rate Limiting: Be mindful of rate limits when implementing frequent health checks

Next Steps

Once you've successfully tested your connection with the ping endpoint, you can proceed to:

Create your first payment

Manage clients

Generate invoices

Ping

Ping#

Overview#

Endpoints#

GET /v2/ping#

Request#

Response#

Code Examples#

JavaScript/Node.js#

Python#

PHP#

Error Codes#

Best Practices#

Next Steps#

Ping

Overview

Endpoints

GET /v2/ping

Request

Response

Code Examples

JavaScript/Node.js

Python

PHP

Error Codes

Best Practices

Next Steps