Skip to main content
GET
Get Nanopayments Gateway status
Diagnostic endpoint that reports the facilitator’s Circle Gateway client status, the per-network enablement map, and the upstream getSupported() payload from Circle’s Gateway API. Use it to confirm Gateway connectivity and check which networks are currently routable through the batched path before integrating.

Authentication

Requires Authorization: Bearer <api-key>. The endpoint requires req.auth.organization.id to be present after the apiSession middleware runs; otherwise it returns HTTP 401.

Response

The literal response body returned by the facilitator:
The endpoints.batchedVerify and endpoints.batchedSettle strings (POST /v1/batched-verify / POST /v1/batched-settle) and the usage.description text are returned verbatim by the facilitator but are misleading: those URLs do not exist as distinct routes. Batched payments are routed through the regular POST /v1/verify and POST /v1/settle endpoints, with detection driven by paymentRequirements.extra.name === "GatewayWalletBatched".

Field reference

Errors

401 Unauthorized

Returned when the request has no organization context after apiSession:

500 Internal Server Error

Returned when the route handler throws (Circle unreachable for reasons other than the wrapped getSupported() call, etc.):

Authorizations

Authorization
string
header
required

Response

Gateway status

success
boolean
Example:

true

data
object