Api Basics
API configuration, authentication, and webhook integration.
Before You Start
Read the following guides before proceeding:
| Guide | Why |
|---|---|
| Environments | API base URLs per environment |
Required Headers
Mandatory Headers
The following header is required for all API requests:
| Header | Value | Description |
|---|---|---|
X-Chain-Id | Chain ID | Target blockchain identifier |
Common Headers
| Header | Value | When Required |
|---|---|---|
Authorization | Bearer <token> | Most endpoints (see auth flow) |
Content-Type | application/json | Requests with JSON body |
Auth-Specific Headers
Depending on the authentication flow, additional headers may be required. See Authentication for details.
Network Requirements
HTTPS
- All API requests require HTTPS
- TLS 1.2+ required
- Validate SSL certificates in production
IP Allowlisting
S2S token exchange endpoint:
IP allowlisting is available for the POST /api/v1/token endpoint. Contact Wirex to configure allowed IPs for your credentials.
Wirex webhooks to your endpoints: If you need to allowlist Wirex IPs for incoming webhook requests, contact Wirex to obtain the list of webhook source IPs.
Timeouts
Recommended request timeouts:
- API requests: 30 seconds
- Webhook delivery: Wirex uses 10 second timeout
Webhooks
Wirex sends webhook notifications for state changes. Webhook URLs are configured by Wirex during onboarding.
Provide your webhook base URL (HTTPS) during onboarding. Wirex will configure the endpoints for your company.
See Webhooks for endpoint paths, payload formats, and implementation details.
Updated 8 days ago