Skip to content

Ping

Ping is a lightweight endpoint used to confirm that an API credential is valid.

A successful call confirms the request reached the server and the token was accepted. The response reports the request is authenticated and which merchant it resolves to.

The Ping endpoint supports a single health check call. A response with a merchantId confirms the API key is valid and requests can proceed. A missing or null merchantId means the API key, client ID, or client secret should be checked.

  • GET /pay-int-api/ping. Confirms the request is authenticated and returns the merchant it resolves to.
Operations

Pings an endpoint for health status

Request

GET {{baseURL}}/pay-int-api/ping

This endpoint ping endpoint to validate the token is active and valid.

Security
Bearer
Headers
x-api-versionstring

Specifies the API version to use for the request.

Example: 1.0

Example:1.0
curl -i -X GET \
  https://developer.flute.com/_mock/api-reference/pay-int-api/ping \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-version: 1.0'

Responses

OK

Body
authenticatedboolean

Indicates the request is authenticated.

If true, the request is authenticated.
If false, the request is not authenticated.

Example: true

Example:true
merchantIdstring or null, (uuid)

Indicates the identifier of the merchant.

If a value is provided, the API key is valid and requests can be made.
If a value is omitted or null, the API key is not valid. It may mean that the API key is not associated with this merchant. Check that the API key, clientId, and client secret are correct.

Example: 46063d32-10fa-44cb-b118-20ddd085ce3f

Example:"46063d32-10fa-44cb-b118-20ddd085ce3f"
clientIdstring or null, (uuid)

Indicates the first value association with the API key.

The second value association with the API key, the client secret, is never shown after the initial creation.

Example: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5

Example:"3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5"
Response
{
  "authenticated": true,
  "merchantId": "46063d32-10fa-44cb-b118-20ddd085ce3f",
  "clientId": "3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5"
}