API navigator

Abstract

The Partner API enables partners to offer non-custodial crypto accounts, card services, and fiat on-ramps directly inside their own platforms. Powered by Wirex Pay, this API provides secure endpoints for onboarding users, managing wallets, and processing transactions while maintaining full compliance and auditability.

Onboarding

The onboarding process in the Wirex Pay Partner API supports both on-chain onboarding and off-chain onboarding. Both are required to enable a fully non-custodial user experience within the Wirex Pay ecosystem.

On-Chain Onboarding

On-chain onboarding involves the creation of a deterministic smart account using the Accounts Contract. This is the foundation of the non-custodial model, allowing users to retain full ownership and control over their assets through a decentralized wallet.

Off-Chain Onboarding

Off-chain onboarding handles the user identity layer, involving email/SMS verification flows and background KYC checks. It binds the off-chain identity to the on-chain wallet, orchestrates KYC flows, and enables services such as card issuance and transaction monitoring.

Auth

The Wirex Pay Partner API supports multiple authentication schemes to suit different integration models. Whether you run a full server-side system or embed authentication directly into your frontend, the platform offers flexible and secure methods for accessing user-specific resources.

KYC

The KYC section of the Wirex Pay Partner API enables partners to implement both forward sharing (partners submit their KYC data) and reverse sharing (partners retrieve submitted KYC data) flows. The system integrates with best-in-class identity verification providers and exposes real-time status updates.

User Management

The User Management APIs provide powerful read and write access to user entities across the ecosystem. These endpoints focus on reading user profiles, updating contact details, and managing lifecycle events, ensuring a secure and compliant user experience.

Wallet

The Wallet APIs let you fetch, manage, and interact with the contents of your on-chain AA wallet, including its address and balances. They also expose gas-estimation endpoints and support PayMaster sponsorship.

Confirmation

The Confirmation APIs enable partners to validate high-risk operations by enforcing a secondary challenge. The APIs support SMS delivery and OTP token exchange, ensuring end-user authorization for sensitive operations.

Card Issuance

The Card Issuance API enables the seamless issuance and management of both virtual and physical cards. Virtual cards can be generated instantly and are ideal for secure online transactions. Physical cards are produced and securely shipped to end-users, with measures in place to ensure safety during transit. One such measure is activation after delivery, which prevents unauthorized use or fraudulent spending while the card is in transit.

Card Management

The Card Management APIs facilitate key lifecycle operations such as activation, status modifications (enable, disable, close) and spending limit management.

Card Details

The Card Details APIs enable secure access to sensitive card information, including full PAN, CVV, and expiry date.
Access is strictly controlled, audited, and permitted only through pre-defined, authorized channels in full compliance with PCI DSS standards.

Note: To obtain card details, each request must include strong authentication and will be fully audited.

Card Fees

The Card Fees APIs provide comprehensive details about card-related charges, from FX markups to card-issuance fees incurred during processing.
Responses include a breakdown of costs, applicable currencies, and any dynamic pricing rules configured for the account.

Note: This section is relevant only if your account manager has enabled corporate card-fee handling as part of your integration.

Card Delivery

The Card Delivery APIs surface available courier services and region-based shipping costs for physical cards.
They also expose endpoints for tracking delivery status and estimated arrival times.

Note: Enable this only if physical card delivery has been agreed with your account manager.

3DS & SecureAuth

The Card 3DS APIs handle 3-D Secure authentication flows initiated during online card transactions, including enrolment checks, challenge presentation, and result callbacks.

Bank

The Bank APIs open IBAN accounts, execute SEPA payments, and pull transaction histories. They integrate directly with Wirex Pay banking rails, enabling one-click transfers.

Important context: Ensure the user has passed compliance checks before opening an IBAN account.

Activity Feed

The Activity Feed APIs deliver chronological events spanning cards, wallets, and banking operations.

Important context: Supports pagination and category filters for efficient querying.

Recipients

The Recipients APIs manage trusted payout destinations—crypto addresses or fiat beneficiaries.

Important context: New recipients may require user confirmation for security.

Rates

The Rates APIs return live FX quotes and slippage information, enabling conversions between fiat and digital assets.

Important context: Quotes remain valid for 30 seconds; fetch a new quote if the lock expires.

Updated 7 days ago