Skip to navigation

Generate WebSocket auth token

Issues a single-use token for authenticating a WebSocket connection. Use this instead of polling to get the result of a queued interaction (read-card or charge-card).

After you start an interaction, open a WebSocket connection with this token (wss://javelin.runpayments.io/cable?token=<token>) and subscribe to the channel terminal_job:{interaction_id} to receive real-time status updates.

The token expires after 60 seconds or on first use, whichever comes first.

Authentication

AuthorizationBearer

Use a Payments API key as the bearer token: Authorization: Bearer <api_key>. Get a fresh key from Refresh API Keys.

Query parameters

midstringOptional

Merchant ID. Required when your bearer token is an ISV token acting on behalf of a merchant. If the mid can't be resolved to an authorized account, the request returns 400.

Response

Token issued
tokenstring

Single-use WebSocket auth token. Pass as ?token=<value> when opening the connection. Expires after 60 seconds or first use, whichever comes first.

Errors

401
Unauthorized Error
429
Too Many Requests Error
503
Service Unavailable Error