wire docs

Test an operator connection

Checks that the operator is available and the stored credentials can be read. On success (`status: ok`) a `byo` connection becomes `active`; a connection Wire provisioned for you (`reseller`) is only checked, never switched on here — it is activated by concluding the connector agreement in the dashboard. If the operator cannot be reached the result is `status: unreachable` and the connection is left unchanged.

POST/v1/operator_connections/{id}/test

Authorization

bearerAuth
AuthorizationBearer <token>

Secret API key as a bearer token: Authorization: Bearer sk_live_…. Test keys (sk_test_…) are refused with 401 test_mode_unavailable. Keys are issued per project in the dashboard. Never expose a secret key in browser or mobile code.

In: header

Path Parameters

id*string

Operator connection id (opc_…).

Header Parameters

Idempotency-Key*string

Required on every POST and DELETE (missing → 400 parameter_missing; longer than 255 characters → 400 parameter_invalid). Use one stable key per logical operation, e.g. your order id plus the action. A retry with the same key and the same body returns the recorded response (header Idempotent-Replayed: true) instead of acting twice. The same key with a different body or path → 409 idempotency_key_in_use. While the first request is still running, a duplicate gets 409 idempotency_in_flight — wait a moment and retry. Successful (2xx) and declined (402) responses are recorded for 48 hours; other errors are not, so a retry after fixing a 400 runs normally. Keys are scoped to the API key's project.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/operator_connections/opc_r3mq7z2kw5xt4nvb6cyj2ega2c/test" \  -H "Idempotency-Key: order-1001-create"
{
  "object": "operator_connection_test",
  "operator": "op_example",
  "status": "ok",
  "capabilities": [
    "refund.full"
  ]
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_missing",
    "message": "amount is required",
    "param": "amount",
    "request_id": "req_8f3a1c9e5b7d2f4a6c0e9b1d"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "test_mode_unavailable",
    "message": "test keys are not accepted by this API; use a live secret key",
    "request_id": "req_8f3a1c9e5b7d2f4a6c0e9b1d"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_missing",
    "message": "no such payment_intent",
    "request_id": "req_8f3a1c9e5b7d2f4a6c0e9b1d"
  }
}