Check Match Pro Connection

curl --request GET \
  --url https://api.joinworth.com/integration/api/v1/match-pro/{customerId}/check-connection-status \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "statusConnection": {
      "status": "CONNECTED",
      "message": "Connection established successfully",
      "details": {
        "isActive": true,
        "expiresAt": "2027-01-01T00:00:00.000Z",
        "certificateExpiry": "2027-01-01T00:00:00.000Z"
      }
    }
  }
}

Match Pro

Check Match Pro Connection

Tests whether the stored Match Pro credentials are valid and reachable. Use this endpoint after saving credentials to confirm the setup is working before running match checks.

Status values:

CONNECTED — credentials are valid and the connection is active
NOT_CONNECTED — no credentials saved, or isActive is false
EXPIRED — the key file certificate has passed its expiry date
ERROR — credentials exist but the connection attempt failed

The customerId path parameter must belong to the caller’s tenant. Cross-tenant access is rejected with 403.

GET

match-pro

{customerId}

check-connection-status

Check Match Pro Connection

curl --request GET \
  --url https://api.joinworth.com/integration/api/v1/match-pro/{customerId}/check-connection-status \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "statusConnection": {
      "status": "CONNECTED",
      "message": "Connection established successfully",
      "details": {
        "isActive": true,
        "expiresAt": "2027-01-01T00:00:00.000Z",
        "certificateExpiry": "2027-01-01T00:00:00.000Z"
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId

string

required

UUID of the customer tenant. Must belong to the authenticated caller's tenant.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Query Parameters

acquirerId

string

Optional. Test connectivity for a specific acquirer ID instead of the default stored value.

Example:

"123456"

Response

Connection status retrieved successfully.

status

enum<string>

Available options:

success

data

object

Show child attributes

Overview Get Match Pro Environment

⌘I