# Juicyway API

## Docs

- [Home](https://docs.juicyway.com/home.md): Welcome to the Juicyway Developer Documentation. Here, you'll learn how to create incredible payment experiences securely using our API.
- [Quickstart Guide](https://docs.juicyway.com/quickstart.md): Get started with Juicyway API in minutes.
- [Webhooks](https://docs.juicyway.com/webhooks.md): Integration Guide for Webhook Events
- [API Request Authentication](https://docs.juicyway.com/authentication.md): Authenticate your API calls to Payment related endpoints.
- [Errors](https://docs.juicyway.com/errors.md): Learn how to handle errors when integrating with the Juice API
- [Create Customer](https://docs.juicyway.com/customers/create-customer.md): Create and manage customers within your integration.
- [Update Customer](https://docs.juicyway.com/customers/update-customer.md): Update an existing customer's information
- [Fetch Customer](https://docs.juicyway.com/customers/fetch-customer.md): Retrieve details of a specific customer by their ID
- [List Customers](https://docs.juicyway.com/customers/list-customers.md): Retrieve and filter a paginated list of customers
- [Delete Customer](https://docs.juicyway.com/customers/delete-customer.md): Permanently remove a customer record from your integration
- [Overview](https://docs.juicyway.com/payments/overview.md): Accept payments globally with multiple payment methods and currencies
- [Encryption Keys](https://docs.juicyway.com/payments/encryption-keys.md): Secure your card data with strong encryption
- [Payment Initialization](https://docs.juicyway.com/payments/initialize-payment.md): Payment initialization is the first step in processing any payment through the Juice API. This guide covers the core concepts, supported payment methods, and common parameters required for initializing payments.
- [Card Payment Initialization](https://docs.juicyway.com/payments/initialize-payment/cards.md): Learn how to initialize card payments securely via the Juicyway API
- [Bank Transfer Initialization](https://docs.juicyway.com/payments/initialize-payment/bank-transfers.md): Accept bank transfer payments through virtual accounts for various currencies and banking systems. This guide covers the initialization process for bank transfer payments.
- [Stablecoin Transfer](https://docs.juicyway.com/payments/initialize-payment/stablecoins-transfer.md): Initialize stablecoin payments with support for multiple tokens and chains
- [Interac e-Transfer](https://docs.juicyway.com/payments/initialize-payment/interac-e-transfer.md): Initialize Interac e-Transfer payments for Canadian transactions
- [Payment Capture](https://docs.juicyway.com/payments/capture-payment.md): Payment capture is the binding stage in the transaction lifecycle where funds are transferred from the customer's account to your merchant account. This process occurs after successful authorization and represents the final step in completing a payment.
- [Cards](https://docs.juicyway.com/payments/capture-payment/cards.md)
- [Bank Transfer](https://docs.juicyway.com/payments/capture-payment/bank-transfer.md): Capture payments via bank transfer with virtual accounts
- [Stablecoins payment](https://docs.juicyway.com/payments/capture-payment/stablecoins-payment.md)
- [Interac e-Transfer Capture](https://docs.juicyway.com/payments/capture-payment/interac.md): Process Interac e-Transfer payments for Canadian transactions
- [Authorize Payment](https://docs.juicyway.com/payments/authorize-payment.md): Learn about payment authorization in the Juice API
- [Cards](https://docs.juicyway.com/payments/authorize-payment/cards.md): Auth flow for card transactions.
- [Payment Widget](https://docs.juicyway.com/payments/payment-widget.md): Integrate our secure payment widget into your platform
- [Widget Integration Guide](https://docs.juicyway.com/payments/payment-widget/widget-integration-guide.md): Step-by-step guide to integrate the Juicyway Payment Widget
- [Fetch Payment](https://docs.juicyway.com/payment-transactions/fetch-payment.md): Retrieve details of a specific payment by ID
- [List Payments](https://docs.juicyway.com/payment-transactions/list-payments.md): Retrieve a paginated list of payment transactions with filtering and sorting options.
- [Payment Statistics](https://docs.juicyway.com/payment-transactions/payment-statistics.md): Retrieve aggregate statistics about your payment transactions
- [Transfers Overview](https://docs.juicyway.com/transfers/overview.md): Initiate and manage fund transfers across multiple payment methods and currencies
- [Beneficiaries](https://docs.juicyway.com/transfers/beneficiaries.md): Manage and store transfer recipients for quick, secure payouts
- [Create Beneficiary](https://docs.juicyway.com/transfers/beneficiaries/create-beneficiary.md): Create and save beneficiaries for transfers across multiple payment methods
- [Fetch Beneficiary](https://docs.juicyway.com/transfers/beneficiaries/fetch-beneficiary.md): Retrieve a Specific Beneficiary
- [List Beneficiaries](https://docs.juicyway.com/transfers/beneficiaries/list-beneficiaries.md): Retrieve a paginated list of beneficiaries associated with your account.
- [Resolve NGN Account Number](https://docs.juicyway.com/transfers/transfers/resolve-ngn-account-number.md): Verify Nigerian bank account details before initiating payments
- [List Nigerian Banks](https://docs.juicyway.com/transfers/transfers/list-ngn-banks.md): Retrieve a list of all supported Nigerian banks with their codes
- [Initiate Bank Transfer](https://docs.juicyway.com/transfers/transfers/initiate-bank-transfer.md): Send bank transfers to saved or new beneficiaries
- [Initiate a Stablecoin Transfer](https://docs.juicyway.com/transfers/transfers/initiate-a-stablecoin-transfer.md): Send stablecoin transfers to crypto addresses with support for multiple chains
- [Initiate Bulk Transfer](https://docs.juicyway.com/transfers/bulk-transfers/initiate-bulk-transfers.md): Create a new bulk transfer session for processing multiple transfers efficiently
- [List bulk transfers](https://docs.juicyway.com/transfers/bulk-transfers/list-bulk-transfers.md)
- [Get Bulk Transfer Details](https://docs.juicyway.com/transfers/bulk-transfers/get-bulk-transfer-details.md): Retrieve detailed information about a specific bulk transfer including its status, items, and execution results
- [Update Bulk Transfer](https://docs.juicyway.com/transfers/bulk-transfers/update-bulk-transfer.md): Add or modify transfers within an existing bulk transfer batch
- [Retry Transfer](https://docs.juicyway.com/transfers/bulk-transfers/retry-transfer.md): Retry a previously failed transfer within a bulk transfer batch
- [Execute Bulk Transfer](https://docs.juicyway.com/transfers/bulk-transfers/execute-bulk-transfer.md): Execute a prepared bulk transfer by triggering the payment process for all included transfers
- [Cancel Bulk Transfer](https://docs.juicyway.com/transfers/bulk-transfers/cancel-bulk-transfer.md): Cancel a pending bulk transfer or individual transfers within a batch
- [Delete from Bulk Transfer](https://docs.juicyway.com/transfers/bulk-transfers/delete-bulk-transfer.md): Remove individual transfers from a bulk transfer batch before execution
- [Create a Market Maker](https://docs.juicyway.com/exchange/market-makers/create-market-makers.md): The endpoint below creates a new market maker for the exchange.
- [Get Market Maker](https://docs.juicyway.com/exchange/market-makers/get-market-makers.md): Retrieve details of a specific market maker by ID.
- [Add Contact](https://docs.juicyway.com/exchange/market-makers/add-contact.md): Add a contact to a market maker.
- [Market Makers](https://docs.juicyway.com/exchange/market-makers/list-market-makers.md): Market makers facilitate liquidity on the exchange by providing buy and sell quotes for specific trading pairs. This section outlines how to interact with market maker data via API.
- [Remove Contact](https://docs.juicyway.com/exchange/market-makers/remove-contact.md): Remove a contact from a market maker.
- [Update Market Maker](https://docs.juicyway.com/exchange/market-makers/update-market-maker.md): Update an existing market maker.
- [Create Standing Orders](https://docs.juicyway.com/exchange/standing-orders/create-standing-order.md): Create a new standing order.
- [List Standing Orders](https://docs.juicyway.com/exchange/standing-orders/list-standing-orders.md): Retrieve a list of standing orders with pagination support.
- [Retrieve Standing Order](https://docs.juicyway.com/exchange/standing-orders/get-standing-order.md): Retrieve details of a specific standing order by its ID.
- [Update Standing Order](https://docs.juicyway.com/exchange/standing-orders/update-standing-order.md): Update an existing standing order.
- [Delete Standing Order](https://docs.juicyway.com/exchange/standing-orders/delete-standing-order.md): Delete a standing order by its ID.
- [Create Orders](https://docs.juicyway.com/exchange/orders/create-order.md): Create a new order.
- [Get Order Book](https://docs.juicyway.com/exchange/orders/get-order-book.md): Retrieve the order book for a specific currency pair.
- [List Orders](https://docs.juicyway.com/exchange/orders/list-orders.md): Retrieve a list of orders.
- [Cancel Order](https://docs.juicyway.com/exchange/orders/cancel-order.md): Cancel an existing order.
- [Convert](https://docs.juicyway.com/exchange/rates/convert.md): Converts a specified amount from one currency to another.
- [Create Rates](https://docs.juicyway.com/exchange/rates/create-rates.md): This endpoint creates a new exchange rate.
- [Delete Rates](https://docs.juicyway.com/exchange/rates/delete-rates.md): This endpoint deletes a specified exchange rate by its ID.
- [Fetch Rate](https://docs.juicyway.com/exchange/rates/fetch-rate.md): Retrieves details of a specific exchange rate by its ID.
- [Exchange Rates](https://docs.juicyway.com/exchange/rates/list-rates.md): The endpoint provides a list of currency rates
- [Supported Rates.](https://docs.juicyway.com/exchange/rates/list-supported-pairs.md): Retrieves a list of supported currency pairs for exchange.
- [Update an existing Rate](https://docs.juicyway.com/exchange/rates/update-rates.md): Updates an existing exchange rate by its ID.
- [List Swaps](https://docs.juicyway.com/exchange/swaps/list-swaps.md): Retrieve a list of swaps.
- [Get Swap](https://docs.juicyway.com/exchange/swaps/get-swap.md): Retrieve details of a specific swap by ID.
- [Get Swap Rate](https://docs.juicyway.com/exchange/swaps/get-swap-rate.md): Retrieve the current swap rate for a currency pair.
- [Make Swap](https://docs.juicyway.com/exchange/swaps/make-swaps.md): Execute a swap between two currencies.
- [Create a Swap Configuration](https://docs.juicyway.com/exchange/swap-configurations/create-swap-configuration.md): Create a Swap Configuration
- [List Swap Configuration](https://docs.juicyway.com/exchange/swap-configurations/list-swap-configurations.md): Retrieve a list of swap configurations with pagination support.
- [Retrieve Swap Configuration](https://docs.juicyway.com/exchange/swap-configurations/get-swap-configuration.md): Retrieve details of a specific swap configuration by its ID.
- [Update Swap Configuration](https://docs.juicyway.com/exchange/swap-configurations/update-swap-configuration.md): Update an existing swap configuration.
- [Delete a Swap Configuration](https://docs.juicyway.com/exchange/swap-configurations/delete-swap-configuration.md): Delete a swap configuration by its ID.
- [Overview](https://docs.juicyway.com/waas/overview.md): The Juicyway Wallet API enables businesses to programmatically create and manage customer wallets, fund wallets, and process payouts across supported currencies. This guide describes the required endpoints, request/response formats, and recommended integration flow for Wallet-as-a-Service (WaaS).
- [Create Customer](https://docs.juicyway.com/waas/create-customer.md): Before creating a wallet, you must first create a customer. A customer can be an individual or a business and represents the entity that owns one or more wallets.
- [Create Wallet](https://docs.juicyway.com/waas/create-wallet.md): This endpoint allows you to create a new wallet for a specific customer in a chosen currency. Each wallet is linked to a customer and can be used to manage balances, transactions, and payment methods.
- [Retrieve Wallet](https://docs.juicyway.com/waas/retrieve-wallet.md): This endpoint retrieves the full details of a wallet, including its balance, status, linked payment methods, and historical events. It is commonly used to display wallet information, verify wallet state, and support operational or compliance workflows.
- [Update Wallet Status](https://docs.juicyway.com/waas/update-wallet-status.md): This endpoint allows you to update the operational status of an existing wallet. Wallet status controls whether the wallet can be used for transactions and helps enforce risk, compliance, and lifecycle management rules.
- [Add Payment Method](https://docs.juicyway.com/waas/add-payment-method.md): This endpoint allows you to attach a payment method to an existing wallet. A payment method defines how funds can be added to or withdrawn from a wallet, such as via a bank account.
- [Update wallet balance](https://docs.juicyway.com/waas/process-payout.md): This endpoint is used to debit or credit a wallet balance. It supports internal wallet adjustments such as payouts, refunds, top-ups, or manual balance corrections.
- [Additional Operations](https://docs.juicyway.com/waas/additional-operations.md): This endpoint retrieves a list of wallets. You can filter results by customer, currency, or wallet status.
- [Retrieve a swap configuration](https://docs.juicyway.com/reference/exchange/retrieve-a-swap-configuration.md)
- [Delete a swap configuration](https://docs.juicyway.com/reference/exchange/delete-a-swap-configuration.md)
- [Update a swap configuration](https://docs.juicyway.com/reference/exchange/update-a-swap-configuration.md)
- [List standing orders](https://docs.juicyway.com/reference/exchange/list-standing-orders.md)
- [Create a standing order](https://docs.juicyway.com/reference/exchange/create-a-standing-order.md)
- [Get order book](https://docs.juicyway.com/reference/exchange/get-order-book.md)
- [Convert an amount from one currency to another](https://docs.juicyway.com/reference/exchange/convert-an-amount-from-one-currency-to-another.md)
- [Get rate](https://docs.juicyway.com/reference/exchange/get-rate.md)
- [Delete a rate](https://docs.juicyway.com/reference/exchange/delete-a-rate.md)
- [Update a rate](https://docs.juicyway.com/reference/exchange/update-a-rate.md)
- [Remove contact from a market maker](https://docs.juicyway.com/reference/exchange/remove-contact-from-a-market-maker.md)
- [List rates](https://docs.juicyway.com/reference/exchange/list-rates.md)
- [Create a rate](https://docs.juicyway.com/reference/exchange/create-a-rate.md)
- [List supported rates](https://docs.juicyway.com/reference/exchange/list-supported-rates.md)
- [List market makers](https://docs.juicyway.com/reference/exchange/list-market-makers.md)
- [Create a market maker](https://docs.juicyway.com/reference/exchange/create-a-market-maker.md)
- [List swaps](https://docs.juicyway.com/reference/exchange/list-swaps.md)
- [Make a swap](https://docs.juicyway.com/reference/exchange/make-a-swap.md)
- [Retrieve an order](https://docs.juicyway.com/reference/exchange/retrieve-an-order.md)
- [List orders](https://docs.juicyway.com/reference/exchange/list-orders.md)
- [Create an order](https://docs.juicyway.com/reference/exchange/create-an-order.md)
- [List swap configuration](https://docs.juicyway.com/reference/exchange/list-swap-configuration.md)
- [Create a swap configuration](https://docs.juicyway.com/reference/exchange/create-a-swap-configuration.md)
- [Cancel an order](https://docs.juicyway.com/reference/exchange/cancel-an-order.md)
- [Get swap rate](https://docs.juicyway.com/reference/exchange/get-swap-rate.md)
- [Increase order book liquidity](https://docs.juicyway.com/reference/exchange/increase-order-book-liquidity.md)
- [List currencies](https://docs.juicyway.com/reference/exchange/list-currencies.md)
- [Fetch current market prices](https://docs.juicyway.com/reference/exchange/fetch-current-market-prices.md)
- [Retrieve list of orders created from a standing order](https://docs.juicyway.com/reference/exchange/retrieve-list-of-orders-created-from-a-standing-order.md)
- [Retrieve market maker details for current account](https://docs.juicyway.com/reference/exchange/retrieve-market-maker-details-for-current-account.md)
- [Retrieve a market maker](https://docs.juicyway.com/reference/exchange/retrieve-a-market-maker.md)
- [Update a market maker](https://docs.juicyway.com/reference/exchange/update-a-market-maker.md)
- [Get swap](https://docs.juicyway.com/reference/exchange/get-swap.md)
- [Add contact to a market maker](https://docs.juicyway.com/reference/exchange/add-contact-to-a-market-maker.md)
- [Retrieve a standing order](https://docs.juicyway.com/reference/exchange/retrieve-a-standing-order.md)
- [Delete a standing order](https://docs.juicyway.com/reference/exchange/delete-a-standing-order.md)
- [Update a standing order](https://docs.juicyway.com/reference/exchange/update-a-standing-order.md)
- [Retry failed but retryable transfer](https://docs.juicyway.com/reference/payouts/retry-failed-but-retryable-transfer.md)
- [Delete transfers](https://docs.juicyway.com/reference/payouts/delete-transfers.md)
- [Add transfers](https://docs.juicyway.com/reference/payouts/add-transfers.md)
- [List bulk payouts](https://docs.juicyway.com/reference/payouts/list-bulk-payouts.md)
- [Initiate a bulk transfer](https://docs.juicyway.com/reference/payouts/initiate-a-bulk-transfer.md)
- [cancel bulk transfer](https://docs.juicyway.com/reference/payouts/cancel-bulk-transfer.md)
- [Get payout details](https://docs.juicyway.com/reference/payouts/get-payout-details.md)
- [Generate a payout receipt](https://docs.juicyway.com/reference/payouts/generate-a-payout-receipt.md)
- [Get charge for a payout](https://docs.juicyway.com/reference/payouts/get-charge-for-a-payout.md)
- [List payouts](https://docs.juicyway.com/reference/payouts/list-payouts.md)
- [Initiate a payout](https://docs.juicyway.com/reference/payouts/initiate-a-payout.md)
- [Get bulk payout details](https://docs.juicyway.com/reference/payouts/get-bulk-payout-details.md)
- [Execute bulk transfer](https://docs.juicyway.com/reference/payouts/execute-bulk-transfer.md)
- [Cancel a running payment session](https://docs.juicyway.com/reference/payments/cancel-a-running-payment-session.md)
- [Get merchant profile](https://docs.juicyway.com/reference/payments/get-merchant-profile.md)
- [Update merchant profile](https://docs.juicyway.com/reference/payments/update-merchant-profile.md)
- [Get a payment link](https://docs.juicyway.com/reference/payments/get-a-payment-link.md)
- [Update a payment link](https://docs.juicyway.com/reference/payments/update-a-payment-link.md)
- [Export payment details](https://docs.juicyway.com/reference/payments/export-payment-details.md)
- [Authorize a captured payment session](https://docs.juicyway.com/reference/payments/authorize-a-captured-payment-session.md)
- [Get encryption key](https://docs.juicyway.com/reference/payments/get-encryption-key.md)
- [Get payment stats](https://docs.juicyway.com/reference/payments/get-payment-stats.md)
- [Retry the processing of a pending outgoing payment ](https://docs.juicyway.com/reference/payments/retry-the-processing-of-a-pending-outgoing-payment.md)
- [Get a hosted payment session](https://docs.juicyway.com/reference/payments/get-a-hosted-payment-session.md)
- [List payment links](https://docs.juicyway.com/reference/payments/list-payment-links.md)
- [Create a payment link](https://docs.juicyway.com/reference/payments/create-a-payment-link.md)
- [Get a running payment session](https://docs.juicyway.com/reference/payments/get-a-running-payment-session.md)
- [Capture a payment session](https://docs.juicyway.com/reference/payments/capture-a-payment-session.md)
- [Update a pending payment session](https://docs.juicyway.com/reference/payments/update-a-pending-payment-session.md)
- [Initiate a payment refund](https://docs.juicyway.com/reference/payments/initiate-a-payment-refund.md)
- [Get merchant profile](https://docs.juicyway.com/reference/payments/get-merchant-profile-1.md)
- [Get payment details](https://docs.juicyway.com/reference/payments/get-payment-details.md)
- [Get payment details](https://docs.juicyway.com/reference/payments/get-payment-details-1.md)
- [Initialize a payment session](https://docs.juicyway.com/reference/payments/initialize-a-payment-session.md)
- [Get quote](https://docs.juicyway.com/reference/swaps/get-quote.md)
- [Lock quote](https://docs.juicyway.com/reference/swaps/lock-quote.md)
- [Make a swap with a locked aggregator rate](https://docs.juicyway.com/reference/swaps/make-a-swap-with-a-locked-aggregator-rate.md)
- [Get swap by reference](https://docs.juicyway.com/reference/swaps/get-swap-by-reference.md)
- [Get aggregator swap rate](https://docs.juicyway.com/reference/swaps/get-aggregator-swap-rate.md)
- [Lock aggregator swap rate](https://docs.juicyway.com/reference/swaps/lock-aggregator-swap-rate.md)
- [Fetch current market prices](https://docs.juicyway.com/reference/orders/fetch-current-market-prices.md)
- [Create a wallet](https://docs.juicyway.com/reference/wallets/create-a-wallet.md)
- [List wallets](https://docs.juicyway.com/reference/wallets/list-wallets.md)
- [List transactions](https://docs.juicyway.com/reference/wallets/list-transactions.md)
- [Create a wallet transaction](https://docs.juicyway.com/reference/wallets/create-a-wallet-transaction.md)
- [Retrieve a wallet transaction](https://docs.juicyway.com/reference/wallets/retrieve-a-wallet-transaction.md)
- [Retrieve a wallet](https://docs.juicyway.com/reference/wallets/retrieve-a-wallet.md)
- [Update wallet balance](https://docs.juicyway.com/reference/wallets/update-wallet-balance.md)
- [Create a wallet payment method](https://docs.juicyway.com/reference/wallets/create-a-wallet-payment-method.md)
- [Update a wallet status](https://docs.juicyway.com/reference/wallets/update-a-wallet-status.md)

## OpenAPI Specs

- [openapi](https://docs.juicyway.com/openapi.json)