# Yiksi Pay

## Docs

- [Generate Address](https://docs.yiksipay.com/en/api-reference/addresses/generate-address.md): This endpoint allows you to create a new address for a specific wallet.
- [Get Address](https://docs.yiksipay.com/en/api-reference/addresses/get-address.md): This endpoint retrieves information about a specific address within a wallet.
- [Get Addresses](https://docs.yiksipay.com/en/api-reference/addresses/get-addresses.md): This endpoint retrieves the addresses associated with a specific wallet.
- [Get Balance](https://docs.yiksipay.com/en/api-reference/addresses/get-balance.md): This endpoint retrieves the balance of a specific address within a wallet
- [Get Balances](https://docs.yiksipay.com/en/api-reference/addresses/get-balances.md): This endpoint retrieves the balances associated with a specific address in a wallet.
- [Get transaction](https://docs.yiksipay.com/en/api-reference/addresses/get-transaction.md): Get transaction
- [Get transactions](https://docs.yiksipay.com/en/api-reference/addresses/get-transactions.md): This endpoint retrieves the transactions associated with a specific address in a wallet.
- [Unwhitelist address](https://docs.yiksipay.com/en/api-reference/addresses/unwhitelist-address.md): The endpoint allows the deletion of a specific address from the whitelist of a wallet.
- [Update Address](https://docs.yiksipay.com/en/api-reference/addresses/update-address.md): This endpoint allows the client to update the status of a specific address within a wallet.
- [Whitelist address](https://docs.yiksipay.com/en/api-reference/addresses/whitelist-address.md): This endpoint allows you to whitelist an external address to be monitored based on the wallet policies
- [Lookup](https://docs.yiksipay.com/en/api-reference/aml/lookup.md): This API endpoint is used to perform an anti-money laundering (AML) lookup for a given address and blockchain
- [Execute](https://docs.yiksipay.com/en/api-reference/asset-recovery/salvage.md): Initiates the transfer of assets (native coins or tokens) from a specified sender address to a recipient address within the same wallet ecosystem.
- [Network Fee](https://docs.yiksipay.com/en/api-reference/asset-recovery/salvage-network-fee.md): Calculates and returns the estimated network fee for a potential asset recovery transaction.
- [Add Asset to Wallet](https://docs.yiksipay.com/en/api-reference/asset/add-asset-to-wallet.md): This endpoint allows you to add assets to a specific wallet
- [Get Wallet Assets](https://docs.yiksipay.com/en/api-reference/asset/get-wallet-assets.md): This endpoint retrieves the assets associated with a specific wallet.
- [Remove Asset from Wallet](https://docs.yiksipay.com/en/api-reference/asset/remove-asset-from-wallet.md): This endpoint is used to delete a specific asset from a wallet.
- [Update Wallet Asset](https://docs.yiksipay.com/en/api-reference/asset/update-wallet-asset.md): This endpoint allows the client to update the status of a specific asset within a wallet.
- [Authentication](https://docs.yiksipay.com/en/api-reference/authentication.md): Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the [dashboard](https://dashboard.yiksipay.com/developers).
- [Child Address](https://docs.yiksipay.com/en/api-reference/auto-settlements/child-address.md): This endpoint retrieves the auto settlement configurations for a specific address identified. It provides details about the rules and settings associated with automatic settlements for the specified address.
- [Child Address Create Rule](https://docs.yiksipay.com/en/api-reference/auto-settlements/child-address-create-rule.md): This endpoint allows you to create a new auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can define the conditions and actions for the auto-settlement process.
- [Child Address Delete Rule](https://docs.yiksipay.com/en/api-reference/auto-settlements/child-address-delete-rule.md): This endpoint allows users to delete a specific auto settlement rule associated with a address. The rule is identified by the `id` parameter in the URL,
- [Child Address Get Rule](https://docs.yiksipay.com/en/api-reference/auto-settlements/child-address-get-rule.md): This endpoint allows you to retrieve the details of a specific auto-settlement rule associated with a particular address.
- [Child Address Get Rules](https://docs.yiksipay.com/en/api-reference/auto-settlements/child-address-get-rules.md): This endpoint retrieves the auto-settlement rules associated with a specific address.
- [Child Address Update](https://docs.yiksipay.com/en/api-reference/auto-settlements/child-address-update.md): This endpoint allows you to update the auto-settlement settings for a specific address. The primary purpose of this request is to enable or disable the auto-settlement feature for the address.
- [Child Address Update Rule](https://docs.yiksipay.com/en/api-reference/auto-settlements/child-address-update-rule.md): This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process.
- [Master Wallet](https://docs.yiksipay.com/en/api-reference/auto-settlements/master-wallet.md): This endpoint retrieves the auto settlement configurations for a specific wallet identified. It provides details about the rules and settings associated with automatic settlements for the specified wallet.
- [Master Wallet Create Rule](https://docs.yiksipay.com/en/api-reference/auto-settlements/master-wallet-create-rule.md): This endpoint allows you to create a new auto-settlement rule for a specific wallet. By providing the necessary parameters in the request body, you can define the conditions and actions for the auto-settlement process.
- [Master Wallet Delete Rule](https://docs.yiksipay.com/en/api-reference/auto-settlements/master-wallet-delete-rule.md): This endpoint allows users to delete a specific auto settlement rule associated with a wallet. The rule is identified by the `id` parameter in the URL,
- [Master Wallet Get Rule](https://docs.yiksipay.com/en/api-reference/auto-settlements/master-wallet-get-rule.md): This endpoint allows you to retrieve the details of a specific auto-settlement rule associated with a particular wallet.
- [Master Wallet Get Rules](https://docs.yiksipay.com/en/api-reference/auto-settlements/master-wallet-get-rules.md): This endpoint retrieves the auto-settlement rules associated with a specific wallet.
- [Master Wallet Update](https://docs.yiksipay.com/en/api-reference/auto-settlements/master-wallet-update.md): This endpoint allows you to update the auto-settlement settings for a specific wallet. The primary purpose of this request is to enable or disable the auto-settlement feature for the wallet.
- [Master Wallet Update Rule](https://docs.yiksipay.com/en/api-reference/auto-settlements/master-wallet-update-rule.md): This endpoint allows you to update an existing auto-settlement rule for a specific wallet. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process.
- [Create](https://docs.yiksipay.com/en/api-reference/beneficiaries/create.md): This endpoint allows you to add a beneficiary to a specific wallet.
- [Delete](https://docs.yiksipay.com/en/api-reference/beneficiaries/delete.md): This API endpoint is used to delete a beneficiary from a specific wallet.
- [Get all](https://docs.yiksipay.com/en/api-reference/beneficiaries/get-all.md): The endpoint retrieves the list of beneficiaries associated with a specific wallet.
- [Get one](https://docs.yiksipay.com/en/api-reference/beneficiaries/get-one.md): This endpoint retrieves details of a specific beneficiary associated with a wallet.
- [Update](https://docs.yiksipay.com/en/api-reference/beneficiaries/update.md): This endpoint allows you to update the details of a specific beneficiary associated with a wallet.
- [Errors](https://docs.yiksipay.com/en/api-reference/errors.md): Yiksi Pay's API is RESTful and as such, uses conventional HTTP response codes to indicate the success or failure of requests.
- [Introduction](https://docs.yiksipay.com/en/api-reference/introduction.md): Learn how to seamlessly integrate our APIs into your application.
- [Get Assets](https://docs.yiksipay.com/en/api-reference/miscellaneous/get-assets.md): This endpoint allows to retrieve a list of assets supported by Yiksi Pay
- [Get Blockchains](https://docs.yiksipay.com/en/api-reference/miscellaneous/get-blockchains.md): This endpoint retrieves a list of supported blockchains by Yiksi Pay
- [Get Rates](https://docs.yiksipay.com/en/api-reference/miscellaneous/get-rates.md): This endpoint retrieves the current rates of specified assets in the given currency.
- [Child Address Typed data](https://docs.yiksipay.com/en/api-reference/signing/child-address-typed-data.md): This endpoint allows you to sign typed data for a specific wallet identified by its ID. Supports all EIP-712 standards including EIP-3009, EIP-2612, and custom typed data structures.
- [Master Wallet Typed data](https://docs.yiksipay.com/en/api-reference/signing/master-wallet-typed-data.md): This endpoint allows you to sign typed data for a specific wallet identified by its ID. Supports all EIP-712 standards including EIP-3009, EIP-2612, and custom typed data structures.
- [Child address network fee](https://docs.yiksipay.com/en/api-reference/smart-contract/child-address-network-fee.md)
- [Child Address Read](https://docs.yiksipay.com/en/api-reference/smart-contract/child-address-read.md): This API provides endpoints for interacting with smart contracts on the blockchain. It allows for reading contract data,
- [Child Address Write](https://docs.yiksipay.com/en/api-reference/smart-contract/child-address-write.md): This API provides endpoints for interacting with smart contracts on the blockchain. It allows for executing contract functions.
- [Child Address Write Sign-Only](https://docs.yiksipay.com/en/api-reference/smart-contract/child-address-write-sign-only.md): This API provides endpoints for interacting with smart contracts on the blockchain. It allows for executing contract functions without broadcasting.
- [Master Wallet Network Fee](https://docs.yiksipay.com/en/api-reference/smart-contract/master-wallet-network-fee.md): This API provides endpoints for interacting with smart contracts on the blockchain. It allows estimating network fees.
- [Master Wallet Read](https://docs.yiksipay.com/en/api-reference/smart-contract/master-wallet-read.md): This API provides endpoints for interacting with smart contracts on the blockchain. It allows for reading contract data,
- [Master Wallet Write](https://docs.yiksipay.com/en/api-reference/smart-contract/master-wallet-write.md): This API provides endpoints for interacting with smart contracts on the blockchain. It allows for executing contract functions.
- [Master Wallet Write Sign-Only](https://docs.yiksipay.com/en/api-reference/smart-contract/master-wallet-write-sign-only.md): This API provides endpoints for interacting with smart contracts on the blockchain. It allows for executing contract functions without broadcasting
- [Child Address Execute](https://docs.yiksipay.com/en/api-reference/swap/child-address-execute.md): This endpoint allows the execution of a swap.
- [Child Address Get Quote](https://docs.yiksipay.com/en/api-reference/swap/child-address-get-quote.md): This endpoint allows you to retrieve a quote for swapping assets.
- [Master Wallet Execute](https://docs.yiksipay.com/en/api-reference/swap/master-wallet-execute.md): This endpoint allows the execution of a swap.
- [Master Wallet Get Quote](https://docs.yiksipay.com/en/api-reference/swap/master-wallet-get-quote.md): This endpoint allows you to retrieve a quote for swapping assets.
- [Cancel Transaction](https://docs.yiksipay.com/en/api-reference/transactions/cancel-transaction.md): Cancel Transaction
- [Get transaction](https://docs.yiksipay.com/en/api-reference/transactions/get-transaction.md): The endpoint retrieves the details of a specific transaction associated with a wallet.
- [Get Transactions](https://docs.yiksipay.com/en/api-reference/transactions/get-transactions.md): This endpoint retrieves the transactions associated with a specific wallet.
- [Resend Webhook](https://docs.yiksipay.com/en/api-reference/transactions/resend-webhook.md): This endpoint is used to resend webhooks for transactions associated with a specific wallet.
- [Retry Transaction](https://docs.yiksipay.com/en/api-reference/transactions/retry-transaction.md): Retry Transaction
- [Trigger Asset Sweep](https://docs.yiksipay.com/en/api-reference/transactions/trigger-asset-sweep.md): ### Trigger Asset Sweep
- [Webhook Logs](https://docs.yiksipay.com/en/api-reference/transactions/webhook-logs.md): This endpoint retrieves the webhooks associated with a specific transaction within a wallet
- [Deposit Finder](https://docs.yiksipay.com/en/api-reference/wallet/deposit-finder.md): This endpoint is used to initiate a rescan of blocks for a specific wallet.
- [Get Balance](https://docs.yiksipay.com/en/api-reference/wallet/get-balance.md): This endpoint retrieves the balance of a specific wallet for a given asset.
- [Get Balances](https://docs.yiksipay.com/en/api-reference/wallet/get-balances.md): This endpoint retrieves the balances of a specific wallet.
- [Get Wallet](https://docs.yiksipay.com/en/api-reference/wallet/get-wallet.md): This endpoint retrieves the details of a specific wallet
- [Trigger Sweep Assets](https://docs.yiksipay.com/en/api-reference/wallet/trigger-sweep-assets.md): This endpoint is used to manually trigger assets sweep for all unswept assets for a specific wallet
- [Update wallet](https://docs.yiksipay.com/en/api-reference/wallet/update-wallet.md): This endpoint allows you to update the details of a specific wallet
- [Webhooks Logs](https://docs.yiksipay.com/en/api-reference/wallet/webhooks-logs.md): This endpoint retrieves the webhooks associated with a specific wallet
- [Child Address](https://docs.yiksipay.com/en/api-reference/withdraw/child-address.md): This endpoint allows you to initiate a withdrawal from a specific address
- [Child Address  Network Fee](https://docs.yiksipay.com/en/api-reference/withdraw/child-address-network-fee.md): This endpoint is used to calculate the network fee for a withdrawal from a specific address.
- [Child Address Sign-Only](https://docs.yiksipay.com/en/api-reference/withdraw/child-address-sign-only.md): This endpoint allows you to initiate a withdrawal from a specific address without broadcasting
- [Master Wallet](https://docs.yiksipay.com/en/api-reference/withdraw/master-wallet.md): This endpoint allows you to initiate a withdrawal from a specific wallet.
- [Master Wallet Network Fee](https://docs.yiksipay.com/en/api-reference/withdraw/master-wallet-network-fee.md): This API endpoint is used to get the withdrawal network fee from a specific wallet.
- [Master Wallet Sign-Only](https://docs.yiksipay.com/en/api-reference/withdraw/master-wallet-sign-only.md): This endpoint allows you to sign a withdrawal from a specific wallet without broadcasting
- [Addresses](https://docs.yiksipay.com/en/essentials/addresses.md): Learn how to create dedicated addresses for your customers to deposit stablecoins
- [Asset Recovery](https://docs.yiksipay.com/en/essentials/asset-recovery.md): Recover assets sent to the correct address on the wrong blockchain
- [Auto Settlements](https://docs.yiksipay.com/en/essentials/auto-settlements.md): Automate asset settlements and conversions across blockchain networks
- [Integrations](https://docs.yiksipay.com/en/essentials/integrations.md): Overview of blockchain networks and stablecoins supported by Yiksi Pay on both mainnet and testnet
- [Smart Contracts](https://docs.yiksipay.com/en/essentials/smart-contracts.md): Interact with any smart contract directly from your Yiksi Pay wallet
- [Swap & Bridge](https://docs.yiksipay.com/en/essentials/swap.md): Exchange assets across chains with a unified API
- [Wallets](https://docs.yiksipay.com/en/essentials/wallets.md): Learn how to manage your master wallets
- [Webhooks](https://docs.yiksipay.com/en/essentials/webhooks.md): Webhooks allow you to set up a notification system that can be used to receive updates on certain requests made to the Yiksi Pay API.
- [Withdrawals](https://docs.yiksipay.com/en/essentials/withdrawals.md): Send stablecoin assets to external addresses with single and batch operations
- [Introduction](https://docs.yiksipay.com/en/introduction.md): Welcome to the Yiksi Pay Developer Documentation. Here, you’ll learn how to build amazing experiences for your customers using the Yiksi Pay API.
- [Disaster Recovery](https://docs.yiksipay.com/en/security/disaster-recovery.md): Learn how Yiksi Pay ensures business continuity and fund security during disasters.
- [Security & Architecture](https://docs.yiksipay.com/en/security/introduction.md): Learn how Yiksi Pay achieves innovative, enterprise-grade, no single point of failure security.
- [Key Management](https://docs.yiksipay.com/en/security/key-management.md): Learn how Yiksi Pay achieves innovative, enterprise-grade, no single point of failure security.
- [Our Approach](https://docs.yiksipay.com/en/security/our-approach.md): Learn how Yiksi Pay achieves innovative, enterprise-grade, no single point of failure security.
- [Reporting a Vulnerability](https://docs.yiksipay.com/en/security/report-vulnerability.md): Learn how Yiksi Pay achieves innovative, enterprise-grade, no single point of failure security.
- [Shared Responsibility Model](https://docs.yiksipay.com/en/security/shared-responsibility.md): Learn how Yiksi Pay achieves innovative, enterprise-grade, no single point of failure security.

## OpenAPI Specs

- [openapi](https://docs.yiksipay.com/openapi.yml)