# Wirex BaaS Documentation

## Guides
- [Agent Skills](https://docs.wirexapp.com/docs/agent-skills.md): Pre-built skills for AI agents to integrate with Wirex BaaS.
- [MCP Server](https://docs.wirexapp.com/docs/mcp-server.md): Enable AI-powered development tools to interact with Wirex BaaS API and documentation.
- [Card Limit Increase](https://docs.wirexapp.com/docs/card-limit-increase.md): Process for requesting customer card limit increases above standard thresholds.
- [For Business](https://docs.wirexapp.com/docs/For Business.md): Partner onboarding, compliance processes, and operational guides for Wirex BaaS.
- [Partner Onboarding](https://docs.wirexapp.com/docs/partner-onboarding-guide.md): Three-track onboarding process from initial enquiry to production go-live.
- [Activity History](https://docs.wirexapp.com/docs/activity-history.md): Query and filter transaction history.
- [Reading User Transactions](https://docs.wirexapp.com/docs/activities.md): Query transaction history and track activity status.
- [Authentication](https://docs.wirexapp.com/docs/authentication.md): Authentication methods for Wirex BaaS API integration.
- [Api Basics](https://docs.wirexapp.com/docs/api-basics.md): API configuration, authentication, and webhook integration.
- [Webhooks](https://docs.wirexapp.com/docs/webhooks.md): Real-time notifications for entity state changes delivered to your configured endpoints.
- [ACH Bank Details](https://docs.wirexapp.com/docs/ach-bank-details.md): Get ACH bank account details for receiving USD transfers.
- [ACH Bank Transfer](https://docs.wirexapp.com/docs/ach-bank-transfer.md): Send USD to external ACH bank accounts.
- [Using Bank Accounts](https://docs.wirexapp.com/docs/bank-accounts.md): Manage bank account details for fiat deposits and withdrawals.
- [SEPA Bank Details](https://docs.wirexapp.com/docs/sepa-bank-details.md): Get SEPA bank account details for receiving EUR transfers.
- [SEPA Bank Transfer](https://docs.wirexapp.com/docs/sepa-bank-transfer.md): Send EUR to external SEPA bank accounts.
- [3DS Authentication](https://docs.wirexapp.com/docs/3ds-authentication.md): Handle 3D Secure authentication for card transactions.
- [Read Card Details](https://docs.wirexapp.com/docs/card-details.md): Retrieve sensitive card data (PAN, CVV, PIN) with user confirmation.
- [Issue and Manage a Card](https://docs.wirexapp.com/docs/card-issuance.md): Issue virtual and physical payment cards linked to user wallets.
- [Card Transactions](https://docs.wirexapp.com/docs/card-transactions.md): Understand the card transaction lifecycle, on-chain execution, and webhook notifications.
- [Issuing and Using Cards](https://docs.wirexapp.com/docs/cards.md): Issue payment cards, handle transactions, and manage 3DS authentication.
- [Card Limits](https://docs.wirexapp.com/docs/managing-card-limits.md): Set and manage daily spending limits on payment cards.
- [Global Addresses](https://docs.wirexapp.com/docs/global-addresses.md): Multi-chain deposit addresses powered by Rhino.fi for receiving tokens from any supported chain.
- [Managing Crypto Assets](https://docs.wirexapp.com/docs/crypto-assets.md): Handle unified balances, deposits, and withdrawals.
- [Unified Balance](https://docs.wirexapp.com/docs/unified-balance.md): How WUSD and WEUR unified stablecoins power chain-agnostic balance management in Wirex BaaS.
- [Withdrawals](https://docs.wirexapp.com/docs/withdrawals.md): Withdraw crypto from user wallets to external addresses using on-chain execution.
- [Onboarding a User](https://docs.wirexapp.com/docs/dev-onboarding.md): Register users, deploy wallets, and complete KYC verification.
- [Wallet Deployment](https://docs.wirexapp.com/docs/onchain-registration.md): Deploy Account Abstraction wallets, install required modules, and register in the Wirex Accounts contract.
- [User Onboarding](https://docs.wirexapp.com/docs/user-onboarding.md): Overview of the user onboarding flow from wallet creation to KYC completion.
- [Authorization API](https://docs.wirexapp.com/docs/extauth-api.md): Implement the authorization endpoints Wirex calls before processing transactions.
- [Card Transactions](https://docs.wirexapp.com/docs/extauth-cards.md): How card transactions settle against the Master Account.
- [Registering Users](https://docs.wirexapp.com/docs/extauth-creating-user-2.md): Simplified user registration without on-chain wallet deployment.
- [Overview](https://docs.wirexapp.com/docs/extauth-overview.md): What External Authorization is and how it differs from standard integration.
- [External Authorization](https://docs.wirexapp.com/docs/external-authorization.md): Partner-managed balances with Master Account settlement.
- [Credentials](https://docs.wirexapp.com/docs/credentials.md): API credentials, on-chain identifiers, and smart contract addresses provided by Wirex.
- [Environments](https://docs.wirexapp.com/docs/environments.md): API endpoints, supported chains, and sandbox credentials for testing.
- [Getting Started](https://docs.wirexapp.com/docs/getting-started.md): Get started with Wirex BaaS platform setup, environments, and credentials.
- [Completing the KYC](https://docs.wirexapp.com/docs/kyc.md): Identity verification flows for user onboarding and feature access.
- [Reliance](https://docs.wirexapp.com/docs/kyc-api.md): Provide complete verified user data to Wirex when you handle KYC verification.
- [Wirex Hosted KYC](https://docs.wirexapp.com/docs/kyc-hosted.md): Collect basic user data and let users complete KYC verification through Wirex's hosted flow.
- [Sharing Data Through SumSub](https://docs.wirexapp.com/docs/kyc-shared.md): Share existing SumSub verification with Wirex for pre-verified users.
- [Card Tokenization](https://docs.wirexapp.com/docs/card-tokenization.md): Register external payment cards for push to card transfers.
- [Card Transfer](https://docs.wirexapp.com/docs/card-transfer.md): Execute push to card transfers from user wallet to external payment cards.
- [Sending a Card Payment](https://docs.wirexapp.com/docs/push-to-card.md): Transfer funds from user wallets to external payment cards via OCT.
- [Managing Recipients](https://docs.wirexapp.com/docs/recipients.md): Manage transfer recipients for bank accounts, cards, and crypto addresses.
- [Create Recipients](https://docs.wirexapp.com/docs/recipients-create.md): Create recipients with payment details for transfers.
- [Manage Recipients](https://docs.wirexapp.com/docs/recipients-manage.md): Update and delete recipients and their payment details.
- [Recipients Overview](https://docs.wirexapp.com/docs/recipients-overview.md): List and filter saved transfer recipients.
- [Testing in Sandbox](https://docs.wirexapp.com/docs/sandbox-testing.md): Simulate external events for end-to-end testing in sandbox environment.
- [Helper API Reference](https://docs.wirexapp.com/docs/sandbox-testing.md): API reference for sandbox test event simulation.
- [TypeScript / JavaScript SDK](https://docs.wirexapp.com/docs/sdk.md): Official typed SDK for Wirex BaaS — authentication, BaaS API, on-chain wallet operations, and crypto transfers in a single npm package.
- [ABI Reference](https://docs.wirexapp.com/docs/abi-reference.md): ABI definitions for Wirex smart contract integration.
- [Capabilities](https://docs.wirexapp.com/docs/capabilities.md): Understand and evaluate user capabilities for feature access.
- [Working with User Profile](https://docs.wirexapp.com/docs/user-profile.md): Retrieve user information, verification status, and capabilities.
- [User Information](https://docs.wirexapp.com/docs/user-info.md): Retrieve user profile, verification status, and capabilities.
- [How it works](https://docs.wirexapp.com/docs/how-it-works.md): Wirex BaaS enables partners to offer blockchain-based financial services to their users.
- [Platform Overview](https://docs.wirexapp.com/docs/introduction.md): Wirex BaaS enables partners to offer blockchain-based financial services to their users.
- [Partner Onboarding](https://docs.wirexapp.com/docs/partner-onboarding.md): Information exchange between partners and Wirex during integration setup.
- [Bank Account Availability](https://docs.wirexapp.com/docs/bank-account-availability.md): Countries where SEPA and ACH bank accounts are available.
- [Global Address Support](https://docs.wirexapp.com/docs/global-address-support.md): Supported blockchain networks and tokens for deposits.
- [Supported Countries](https://docs.wirexapp.com/docs/supported-countries.md): List of countries where Wirex BaaS non-custodial card services are available.

## API Reference
- [Get activity feed](https://docs.wirexapp.com/reference/get_api-v1-activity-feed.md): Retrieves both transactional and non-transactional activities for the user
- [Get activity](https://docs.wirexapp.com/reference/get_api-v1-activity-single-id.md): Retrieves single activity item by its id
- [Get requested erc withdrawals](https://docs.wirexapp.com/reference/get_api-v1-withdrawal-requests.md): Retrieves requested erc withdrawals for provided account address
- [Get full statement](https://docs.wirexapp.com/reference/post_api-v1-activity-statement-full.md): Retrieves a statement for the user for the specified period.</br>The statement includes all transactions, including deposits, withdrawals, and transfers that occurred during the specified period.
- [Get Wirex Partner token](https://docs.wirexapp.com/reference/post_api-v1-token.md): Exchange client credentials for Wirex Partner access token
- [Login as user](https://docs.wirexapp.com/reference/post_api-v1-user-authorize.md): Retrieve access token for a specific user that can be used to interact with all other APIs on his behalf
- [Get bank accounts](https://docs.wirexapp.com/reference/get_api-v1-bank-accounts.md): Retrieves a list of bank accounts that belong to the user
- [Create bank account](https://docs.wirexapp.com/reference/post_api-v1-bank-accounts.md): Activates bank account details for the specified account type
- [Estimate bank transfer](https://docs.wirexapp.com/reference/post_api-v1-bank-transfer-estimate.md): Estimates the amounts that would be charged for a bank transfer according to the current market rates.
- [Execute bank transfer](https://docs.wirexapp.com/reference/post_api-v1-bank-transfer.md): Executes the bank transfer either according to the estimation made previously or using current market rates.
- [Estimate bank transfer](https://docs.wirexapp.com/reference/post_api-v2-bank-transfer-estimate.md): Estimates the amounts that would be charged for a bank transfer according to the current market rates.
- [Estimate corridor transfer](https://docs.wirexapp.com/reference/post_api-v3-bank-corridor-estimate.md): Estimates the amounts for a bank transfer via specified corridor
- [Execute transfer by corridor](https://docs.wirexapp.com/reference/post_api-v3-bank-corridor.md): Executes transfer using estimation_id. All recipient details resolved from stored estimation.
- [Get card](https://docs.wirexapp.com/reference/get_api-v1-cards-cardid.md): Retrieves single card by its id
- [Get cards](https://docs.wirexapp.com/reference/get_api-v1-cards.md): Retrieves list of cards that belong to the user
- [Get active requests](https://docs.wirexapp.com/reference/get_api-v1-cards-3ds-requests.md): Retrieves active 3DS requests that need to be either approved or declined
- [Approve request](https://docs.wirexapp.com/reference/post_api-v1-cards-3ds-requests-transactionid-approve.md): Approves 3DS request allowing the transaction to proceed
- [Decline request](https://docs.wirexapp.com/reference/post_api-v1-cards-3ds-requests-transactionid-decline.md): Declines 3DS request blocking the transaction from proceeding
- [Get delivery countries](https://docs.wirexapp.com/reference/get_api-v1-cards-delivery-countries.md): Retrieves list of countries where the card can be delivered for the current corporation</br> > **Note:** This method is applicable only if your account manager has advised you to incorporate card fee handling as part of your integration process.
- [Get delivery methods](https://docs.wirexapp.com/reference/get_api-v1-cards-delivery-methods-country.md): Retrieves list of courier providers that can deliver the card to the specified country</br> > **Note:** This method is applicable only if your account manager has advised you to incorporate card fee handling as part of your integration process.
- [Get card CVV](https://docs.wirexapp.com/reference/post_api-v1-cards-cardid-cvv.md): Retrieves CVV code for the card using the action confirmation token generated using the **Confirmation** flow
- [Get card details](https://docs.wirexapp.com/reference/post_api-v1-cards-cardid-details.md): Retrieves card PAN and expiry date using the action confirmation token generated using the **Confirmation** flow
- [Get card pin](https://docs.wirexapp.com/reference/post_api-v1-cards-cardid-pin.md): Retrieves card Pin code using the action confirmation token generated using the **Confirmation** flow
- [Get order fees](https://docs.wirexapp.com/reference/get_api-v1-cards-type-fees-country.md): Retrieves estimation of fees that should be paid for the card order</br> > **Note:** This method is applicable only if your account manager has advised you to incorporate card fee handling as part of your integration process.
- [Create order fees invoice](https://docs.wirexapp.com/reference/post_api-v1-cards-type-fees-country-payment.md): Creates an invoice for payment of the card order fees.</br> > **Note:** This method is applicable only if your account manager has advised you to incorporate card fee handling as part of your integration process.
- [Create order fees invoice (V2 - returns delivery_id for direct payment)](https://docs.wirexapp.com/reference/post_api-v2-cards-type-fees-country-payment.md): Creates an invoice for payment of the card order fees. Returns delivery_id to be used with v2 card issuance endpoints.
- [Issue plastic card](https://docs.wirexapp.com/reference/post_api-v1-cards-plastic.md): Issues a plastic card for the specified user and sends it to the provided address.
- [Issue virtual card](https://docs.wirexapp.com/reference/post_api-v1-cards-virtual.md): Issues a virtual card for the specified user
- [Issue plastic card (V2 - with delivery payment)](https://docs.wirexapp.com/reference/post_api-v2-cards-plastic.md): Issues a plastic card for the specified user and sends it to the provided address. Payment is processed using delivery_id from fees invoice.
- [Issue virtual card (V2 - with delivery payment)](https://docs.wirexapp.com/reference/post_api-v2-cards-virtual.md): Issues a virtual card for the specified user. Payment is processed using delivery_id from fees invoice.
- [Activate card](https://docs.wirexapp.com/reference/put_api-v1-cards-cardid-activate.md): Activates a card that has been issued to a user and is currently in **NotActivated** state. </br> **Note:** This endpoint is needed only for physical cards to provide additional layer of security in case the card is stolen during delivery.
- [Block card](https://docs.wirexapp.com/reference/put_api-v1-cards-cardid-block.md): Blocks selected card making it impossible to use it for any transactions.
- [Close card](https://docs.wirexapp.com/reference/put_api-v1-cards-cardid-close.md): Closes the card. This action cannot be undone and the card will be permanently closed.
- [Change card limit](https://docs.wirexapp.com/reference/put_api-v1-cards-cardid-limit.md): Updates maximum amount that can be spent using the card within a day
- [Change card name](https://docs.wirexapp.com/reference/put_api-v1-cards-cardid-name.md): Updates the display name of the card
- [Unblock card](https://docs.wirexapp.com/reference/put_api-v1-cards-cardid-unblock.md): Unblocks selected card allowing it to be used for transactions once again.
- [Create transfer estimation](https://docs.wirexapp.com/reference/post_api-v1-cards-transfer-estimate.md): Creates a new card transfer estimation
- [Executes card transfer request](https://docs.wirexapp.com/reference/post_api-v1-cards-transfer.md): Executes the estimated card transfer request
- [Create withdrawal estimation](https://docs.wirexapp.com/reference/post_api-v1-cards-cardid-withdraw-estimate.md): Creates a new withdrawal estimation for the card
- [Executes the card withdrawal request](https://docs.wirexapp.com/reference/post_api-v1-cards-cardid-withdraw-execute.md): Executes the estimated withdrawal request for the card
- [Get application config](https://docs.wirexapp.com/reference/get_api-v1-config.md): Returns application configuration values for a partner application
- [Verify wallet signature](https://docs.wirexapp.com/reference/post_api-v1-confirmation-signature-verify.md): Exchanges message signed by wallet for a signed JWT token that can be used to confirm an action on the platform
- [Verify SMS code](https://docs.wirexapp.com/reference/post_api-v1-confirmation-sms-verify.md): Exchanges an OTP code sent via SMS for an action token that can be used to confirm that the action being executed is approved by the end-user
- [Request SMS code](https://docs.wirexapp.com/reference/post_api-v1-confirmation-sms.md): Sends an SMS to the phone number that was provided by user during KYC process with OTP code.
- [Get KYC sharing token](https://docs.wirexapp.com/reference/get_api-v1-user-sharing-token.md): Returns a SumSub sharing token that can be used to retrieve the information submitted by the user during the KYC process.
- [Set KYC sharing token](https://docs.wirexapp.com/reference/post_api-v1-user-sharing-token.md): Uses KYC sharing token retrieved from SumSub to ingest user data and perform verification
- [Get KYC SDK link](https://docs.wirexapp.com/reference/post_api-v1-user-verification-link.md): Generates a verification link for the user to verify their account. </br>
- [Get KYC SDK token](https://docs.wirexapp.com/reference/post_api-v1-user-verification-token.md): Retrieves an SDK token for initializing the SumSub SDK. </br>
- [Validate user registered](https://docs.wirexapp.com/reference/post_api-v1-user-retail-validate.md): Validates if the user identified by provided credentials exists in the system and returns basic information about the user if it exists. This endpoint is used in the onboarding process to determine if the user should be redirected to the login or registration page.
- [Create retail user](https://docs.wirexapp.com/reference/post_api-v1-user-retail.md): Creates a new user in the Wirex system using client side Privy SDK authorization.
- [Create user](https://docs.wirexapp.com/reference/post_api-v1-user.md): Creates a new user in the Wirex system using server-side Wirex Partner Credentials authorization.
- [Create user (v2)](https://docs.wirexapp.com/reference/post_api-v2-user.md): Creates a new user in the Wirex system using server-side Wirex Partner Credentials authorization. Optionally accepts sharing_token or initial_data for KYC registration.
- [Get rates](https://docs.wirexapp.com/reference/get_api-v1-rates.md): Retrieves real-time exchange rates for a list of provided tickers. Each ticker represents a currency or asset pair (e.g., `USDT/USD`, `DAI/EUR`). The response includes the latest conversion rate for each requested ticker.
- [Delete payment details](https://docs.wirexapp.com/reference/delete_api-v1-recipients-recipientid-payment-details-paymentdetailsid.md): Deletes payment details from existing recipient
- [Delete recipient](https://docs.wirexapp.com/reference/delete_api-v1-recipients-recipientid.md): Deletes selected recipient
- [Get by catalog](https://docs.wirexapp.com/reference/get_api-v1-recipients-filter-catalog.md): Retrieves recipients filtered by the catalog index. Catalog index is the first letter of the full name, so basically filtering by catalog index provides you with pretty much old yellow pages experience.
- [Get by currency](https://docs.wirexapp.com/reference/get_api-v1-recipients-filter-currency.md): Retrieves recipients filtered by the availability of the requested currency among existing recipient payment details.
- [Get by name](https://docs.wirexapp.com/reference/get_api-v1-recipients-filter-name.md): Retrieves recipients filtered by the presence of passed name substring in the full name of the recipient.
- [Get by type](https://docs.wirexapp.com/reference/get_api-v1-recipients-filter-type.md): Retrieves recipients filtered by availability of the payment details of the passed type.
- [Get recipient by ID](https://docs.wirexapp.com/reference/get_api-v1-recipients-recipientid.md): Retrieves a single recipient by its ID.
- [Get recipients](https://docs.wirexapp.com/reference/get_api-v1-recipients.md): Retrieves all recipients sorted by the full name
- [Create payment details](https://docs.wirexapp.com/reference/post_api-v1-recipients-recipientid-payment-details.md): Creates new payment details for existing recipient
- [Increment recipient usage](https://docs.wirexapp.com/reference/post_api-v1-recipients-recipientid-usage.md): Increments usage index on specified recipient. Usage index is later used to determine recipient's priority in the list of recipients.
- [Create recipient](https://docs.wirexapp.com/reference/post_api-v1-recipients.md): Creates a new recipient with provided personal information
- [Create recipient with payment details](https://docs.wirexapp.com/reference/post_api-v2-recipients.md): Creates recipient with personal info and payment details in a single call
- [Update payment details](https://docs.wirexapp.com/reference/put_api-v1-recipients-recipientid-payment-details-paymentdetailsid.md): Updates existing payment details for existing recipient
- [Update recipient](https://docs.wirexapp.com/reference/put_api-v1-recipients-recipientid.md): Updates recipient with provided personal information
- [Test api request parsing](https://docs.wirexapp.com/reference/get_api-v1-test-type.md): This one exists only to test that API request parsing works correctly from body, query, path and header
- [Get card transactions](https://docs.wirexapp.com/reference/get_api-v1-transactions-card.md): Reads a page of card transactions associated with user
- [Get user](https://docs.wirexapp.com/reference/get_api-v1-user.md): Retrieves the user data stored in Wirex system
- [Get user (v2)](https://docs.wirexapp.com/reference/get_api-v2-user.md): Retrieves extended user account information from the account service including verification status, documents, external provider integrations, available actions and capabilities.
- [Update freshdesk id](https://docs.wirexapp.com/reference/put_api-v1-user-freshdesk-id.md): Updates freshdesk id of the user that can be used to restore omni-chats down the road.
- [Confirm phone number](https://docs.wirexapp.com/reference/put_api-v1-user-phone-number-confirm.md): Update the phone number of a specific user in the system.</br>This endpoint allows updating and validating the user's phone number to maintain account security and contact accuracy.
- [Update phone number](https://docs.wirexapp.com/reference/put_api-v1-user-phone-number.md): Update the phone number of a specific user in the system.</br>This endpoint allows updating and validating the user's phone number to maintain account security and contact accuracy.
- [Upload user document](https://docs.wirexapp.com/reference/post_api-v1-user-documents.md): Uploads a document for user verification (KYC). Accepts multipart/form-data with a file and metadata.
- [Get validation rules](https://docs.wirexapp.com/reference/get_api-v1-validation-rules.md): Returns a list of regex validation rules for common fields in requests
- [Get wallet](https://docs.wirexapp.com/reference/get_api-v1-wallet.md): Retrieves user wallet along with its balances. By wallet this API suggests a valid Account Abstraction wallet that was linked during the registration.
- [Get wallets](https://docs.wirexapp.com/reference/get_api-v1-wallets.md): Retrieves user wallets along with their balances.
- [Create global wallet](https://docs.wirexapp.com/reference/post_api-v1-wallets-global.md): Creates a new global wallet for the user account

## Changelog
- [External Authorization Support](https://docs.wirexapp.com/changelog/external-authorization-support.md)