# Wirex Pay Documentation

> The Wirex Pay Documentation provides comprehensive guidance for partners, developers, and businesses integrating with Wirex Pay's blockchain-based payment ecosystem. This resource covers everything from initial setup to using the Wirex B2B API for secure, programmable payment solutions. Designed to streamline cryptocurrency transactions across traditional and decentralized finance, these docs outline how to leverage Wirex Pay's Zero Knowledge (ZK) technology, support global stablecoin and fiat payments, and ensure seamless cross-chain asset management for Web3 applications.

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Getting Started with Wirex Pay](https://partner.wirexpaychain.com/docs/getting-started.md): This page will help you get started with Wirex Pay. You'll be up and running in a jiffy!
- [Webhooks](https://partner.wirexpaychain.com/docs/webhooks.md)
- [Webhooks V2](https://partner.wirexpaychain.com/docs/webhooks-1.md)
- [Getting Started](https://partner.wirexpaychain.com/docs/installation-and-setup.md): This SDK provides an easy interface to interact with the **Wirex Pay API**, including features like **user management**, **card operations**, **transactions**, **wallet management**, and **action confirmation**. The SDK also supports **real-time WebSocket updates** for changes such as **cards** or **transactions updates**.
- [User](https://partner.wirexpaychain.com/docs/user-service.md): The `UserService` provides methods to manage users, such as updating phone numbers, and fetching user information.
- [Cards](https://partner.wirexpaychain.com/docs/cards-1.md): The `CardService` allows you to manage cards, including blocking, unblocking, activating, and setting limits.
- [Transactions](https://partner.wirexpaychain.com/docs/transactions-1.md): The `TransactionService` handles transaction history and real-time updates for card transactions.
- [Action confirmation](https://partner.wirexpaychain.com/docs/action-confirmation-1.md): The `ActionConfirmationService` manages **SMS confirmations** for various user actions.
- [Wallet](https://partner.wirexpaychain.com/docs/wallet-1.md): The `WalletService` manages wallet information.
- [Glossary and Basics](https://partner.wirexpaychain.com/docs/glossary-and-basics.md)
- [What is the API?](https://partner.wirexpaychain.com/docs/what-is-the-wirex-pay-partner-api.md)
- [Wirex Pay Gen2 ](https://partner.wirexpaychain.com/docs/wirex-pay-gen2.md): Why Account Abstraction Beats Stand-Alone Contracts
- [Card Generations](https://partner.wirexpaychain.com/docs/card-generations.md)
- [Integration architecture](https://partner.wirexpaychain.com/docs/integration-architecture.md): Server‑to‑Server, Front‑Hosted, or Hybrid
- [API navigator](https://partner.wirexpaychain.com/docs/implementation-navigator.md)
- [How Wirex Pay Works](https://partner.wirexpaychain.com/docs/how-it-works.md)
- [Supported countries](https://partner.wirexpaychain.com/docs/supported-countries.md)
- [Card limits](https://partner.wirexpaychain.com/docs/card-limits.md)
- [Bank accounts](https://partner.wirexpaychain.com/docs/bank-accounts.md)
- [External authorization](https://partner.wirexpaychain.com/docs/external-authorization.md): The Master Account External Authorization feature allows partners to manage end-user balances within their own systems while maintaining a prefunded Master Account inside Wirex Pay. Wirex Pay debits the Master Account for transactions only after receiving authorization from the partner’s external API.
- [Onboarding comparsion ](https://partner.wirexpaychain.com/docs/onboarding-comparsion.md): This page outlines the differences between Standard Onboarding and External Authorization Onboarding flows in Wirex Pay.
- [Transaction Processing](https://partner.wirexpaychain.com/docs/transaction-processing.md): This page outlines the differences in transaction processing between Standard Onboarding and External Authorization flows in Wirex Pay.
- [Useful links (onchain)](https://partner.wirexpaychain.com/docs/useful-links.md)
- [Partner external authorization flow](https://partner.wirexpaychain.com/docs/partner-external-authorization-flow.md)
- [Using LLMs](https://partner.wirexpaychain.com/docs/using-llms.md)
- [Stellar Solution Overview](https://partner.wirexpaychain.com/docs/stellar-solution-overview.md)
- [Stellar Onboarding](https://partner.wirexpaychain.com/docs/stellar-onboarding.md)
- [Stellar testnet contracts](https://partner.wirexpaychain.com/docs/stellar-testnet-contracts.md)
- [Unified Stablecoin Balance](https://partner.wirexpaychain.com/docs/unified-balance.md)

## API Reference
- [Authorization](https://partner.wirexpaychain.com/reference/authorization.md)
- [Login as user](https://partner.wirexpaychain.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
- [OnChain Onboarding](https://partner.wirexpaychain.com/reference/onchain-onboarding.md)
- [Create user](https://partner.wirexpaychain.com/reference/post_api-v1-user.md): Creates a new user in the Wirex system using server side Auth0 authorization.
- [Create retail user](https://partner.wirexpaychain.com/reference/post_api-v1-user-retail.md): Creates a new user in the Wirex system using client side Privy SDK authorization.
- [Create retail user](https://partner.wirexpaychain.com/reference/post_api-v1-user-retail-validate.md): Creates a new user in the Wirex system using client side Privy SDK authorization.
- [Get KYC sharing token](https://partner.wirexpaychain.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://partner.wirexpaychain.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://partner.wirexpaychain.com/reference/post_api-v1-user-verification-link.md): Generates a verification link for the user to verify his account. </br>
- [Get KYC SDK token](https://partner.wirexpaychain.com/reference/post_api-v1-user-verification-token.md): Retrieves an SDK token for initializing the SumSub SDK. </br>
- [Get user](https://partner.wirexpaychain.com/reference/get_api-v1-user.md): Retrieves the user data stored in Wirex system
- [Update freshdesk id](https://partner.wirexpaychain.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.
- [Update phone number](https://partner.wirexpaychain.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.
- [Confirm phone number](https://partner.wirexpaychain.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.
- [Get wallets](https://partner.wirexpaychain.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://partner.wirexpaychain.com/reference/get_api-v1-wallets.md): Retrieves user wallets along with its balances.
- [Verify wallet signature](https://partner.wirexpaychain.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
- [Request SMS code](https://partner.wirexpaychain.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.
- [Verify SMS code](https://partner.wirexpaychain.com/reference/post_api-v1-confirmation-sms-verify.md): Exchanges an OTP code send via SMS for an action token that can be used to confirm that the action being executed is approved by end-user
- [Get cards](https://partner.wirexpaychain.com/reference/get_api-v1-cards.md): Retrieves list of cards that belong to the user
- [Get card](https://partner.wirexpaychain.com/reference/get_api-v1-cards-cardid.md): Retrieves single card by its id
- [Issue plastic card](https://partner.wirexpaychain.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://partner.wirexpaychain.com/reference/post_api-v1-cards-virtual.md): Issues a virtual card for the specified user
- [Activate card](https://partner.wirexpaychain.com/reference/put_api-v1-cards-cardid-activate.md): Activates a card that has been issues 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://partner.wirexpaychain.com/reference/put_api-v1-cards-cardid-block.md): Blocks selected card making it impossible to use it for any transactions.
- [Close card](https://partner.wirexpaychain.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://partner.wirexpaychain.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://partner.wirexpaychain.com/reference/put_api-v1-cards-cardid-name.md): Updates the display name of the card
- [Unblock card](https://partner.wirexpaychain.com/reference/put_api-v1-cards-cardid-unblock.md): Unblocks selected card allowing it to be used for transactions once again.
- [Get card CVV](https://partner.wirexpaychain.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://partner.wirexpaychain.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://partner.wirexpaychain.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://partner.wirexpaychain.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://partner.wirexpaychain.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.
- [Get delivery countries](https://partner.wirexpaychain.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://partner.wirexpaychain.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 active requests](https://partner.wirexpaychain.com/reference/get_api-v1-cards-3ds-requests.md): Retrieves active 3DS requests that need to be either approved or declined
- [Approve request](https://partner.wirexpaychain.com/reference/post_api-v1-cards-3ds-requests-transactionid-approve.md): Approves 3DS request allowing the transaction to proceed
- [Decline request](https://partner.wirexpaychain.com/reference/post_api-v1-cards-3ds-requests-transactionid-decline.md): Declines 3DS request blocking the transaction from proceeding
- [Get bank accounts](https://partner.wirexpaychain.com/reference/get_api-v1-bank-accounts.md): Retrieves a list of bank accounts that belong to the user
- [Create bank account](https://partner.wirexpaychain.com/reference/post_api-v1-bank-accounts.md): Activates bank account details for the specified account type
- [Execute bank transfer](https://partner.wirexpaychain.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://partner.wirexpaychain.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.
- [Estimate bank transfer](https://partner.wirexpaychain.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.
- [Get activity feed](https://partner.wirexpaychain.com/reference/get_api-v1-activity-feed.md): Retrieves both transactional and non-transactional activities for the user
- [Get activity](https://partner.wirexpaychain.com/reference/get_api-v1-activity-single-id.md): Retrieves single activity item by its id
- [Get requested erc withdrawals](https://partner.wirexpaychain.com/reference/get_api-v1-withdrawal-requests.md): Retrieves requested erc withdrawals for provided account address
- [Get recipients](https://partner.wirexpaychain.com/reference/get_api-v1-recipients.md): Retrieves all recipients sorted by the full name
- [Create recipient](https://partner.wirexpaychain.com/reference/post_api-v1-recipients.md): Creates a new recipient with provided personal information
- [Get by catalog](https://partner.wirexpaychain.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://partner.wirexpaychain.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://partner.wirexpaychain.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://partner.wirexpaychain.com/reference/get_api-v1-recipients-filter-type.md): Retrieves recipients filtered by availability of the payment details of the passed type.
- [Get by catalog](https://partner.wirexpaychain.com/reference/get_api-v1-recipients-recipientid.md): Retrieves single recipient by its id.
- [Update recipient](https://partner.wirexpaychain.com/reference/put_api-v1-recipients-recipientid.md): Updates recipient with provided personal information
- [Delete recipient](https://partner.wirexpaychain.com/reference/delete_api-v1-recipients-recipientid.md): Deletes selected recipient
- [Create payment details](https://partner.wirexpaychain.com/reference/post_api-v1-recipients-recipientid-payment-details.md): Creates new payment details for existing recipient
- [Update payment details](https://partner.wirexpaychain.com/reference/put_api-v1-recipients-recipientid-payment-details-paymentdetailsid.md): Updates existing payment details for existing recipient
- [Delete payment details](https://partner.wirexpaychain.com/reference/delete_api-v1-recipients-recipientid-payment-details-paymentdetailsid.md): Deletes payment details from existing recipient
- [Increment recipient usage](https://partner.wirexpaychain.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.
- [Get rates](https://partner.wirexpaychain.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
- [Get card transactions](https://partner.wirexpaychain.com/reference/get_api-v1-transactions-card.md): Reads a page of card transactions associated with user
- [Get full statement](https://partner.wirexpaychain.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 validation rules](https://partner.wirexpaychain.com/reference/get_api-v1-validation-rules.md): Returns a list of regex validation rules for common fields in requests
- [OffChain Onboarding](https://partner.wirexpaychain.com/reference/offchain-onboarding.md)
- [Server-Side Onboarding (Auth0-Based)](https://partner.wirexpaychain.com/reference/server-side-onboarding-auth0-based.md)
- [Client-Side Onboarding (Privy SDK)](https://partner.wirexpaychain.com/reference/client-side-onboarding-privy-sdk.md)
- [KYC](https://partner.wirexpaychain.com/reference/kyc.md)
- [User Management](https://partner.wirexpaychain.com/reference/user.md)
- [Confirmation](https://partner.wirexpaychain.com/reference/confirmation.md)
- [Cards](https://partner.wirexpaychain.com/reference/cards.md)
- [Issuance](https://partner.wirexpaychain.com/reference/issuance.md)
- [Bank](https://partner.wirexpaychain.com/reference/bank.md)
- [Activity Feed](https://partner.wirexpaychain.com/reference/activity-feed.md)
- [Recipients](https://partner.wirexpaychain.com/reference/recipients.md)

## Changelog
- [Welcome to Wirex Pay](https://partner.wirexpaychain.com/changelog/welcome-to-wirex-pay.md)