# Confirmo Documentation

> Documentation for Confirmo

## Guides
- [Welcome to Confirmo ](https://docs.confirmo.net/docs/welcome-to-confirmo.md): Confirmo enables businesses to send and receive global payments instantly and securely using stablecoins.
- [Opening Your Account](https://docs.confirmo.net/docs/opening-your-account.md)
- [Setting-up API Keys](https://docs.confirmo.net/docs/setting-up-api-keys.md)
- [Notifications](https://docs.confirmo.net/docs/notifications.md)
- [Merchant Dashboard](https://docs.confirmo.net/docs/merchant-dashboard.md): Merchant dashboard description.
- [Crypto Top-ups](https://docs.confirmo.net/docs/crypto-top-ups.md)
- [Withdrawing Funds](https://docs.confirmo.net/docs/withdrawing-funds.md)
- [Checkout Overview](https://docs.confirmo.net/docs/checkout-overview.md)
- [Accepting Your First Payment](https://docs.confirmo.net/docs/accepting-your-first-payment.md)
- [Processing Webhooks](https://docs.confirmo.net/docs/processing-webhooks.md)
- [Invoice Lifecycle](https://docs.confirmo.net/docs/invoice-lifecycle.md): Invoice lifecycle in possible statuses.
- [Handling Invoice Exceptions](https://docs.confirmo.net/docs/handling-invoice-exceptions.md)
- [Refunds](https://docs.confirmo.net/docs/refunds.md)
- [Customization](https://docs.confirmo.net/docs/customization.md)
- [Embedding Checkout](https://docs.confirmo.net/docs/embedding-checkout.md)
- [Payment & Donation Buttons](https://docs.confirmo.net/docs/payment-donation-buttons.md)
- [Email Invoices](https://docs.confirmo.net/docs/email-invoices.md)
- [WooCommerce Plugin](https://docs.confirmo.net/docs/woocommerce-plugin.md)
- [Deposits Overview](https://docs.confirmo.net/docs/deposits-overview.md)
- [Creating a Deposit Account](https://docs.confirmo.net/docs/creating-a-deposit-account.md)
- [Deposit Lifecycle](https://docs.confirmo.net/docs/deposit-lifecycle.md)
- [Deposit Webhooks](https://docs.confirmo.net/docs/deposit-webhooks.md): If you set a `notifyUrl` on a deposit account, Confirmo sends an HTTP `POST` to that URL whenever something changes — each time a deposit changes status, and when the account itself changes status.
- [Managing Deposit Accounts](https://docs.confirmo.net/docs/managing-deposit-accounts.md): Once a deposit account exists, you can retrieve it, list all your accounts, list the deposits it has received, update its settings, and disable it.
- [Payouts Overview](https://docs.confirmo.net/docs/payouts-overview.md)
- [Sending a Payout](https://docs.confirmo.net/docs/sending-a-payout.md)
- [Payout Permissions](https://docs.confirmo.net/docs/permissions.md)
- [Bulk Payouts](https://docs.confirmo.net/docs/bulk-payouts.md)
- [Programmatic Payouts](https://docs.confirmo.net/docs/programmatic-payouts.md)
- [Handling Payout Fees](https://docs.confirmo.net/docs/handling-payout-fees.md)
- [Payout Lifecycle](https://docs.confirmo.net/docs/payout-states.md)
- [Subscribe Overview](https://docs.confirmo.net/docs/subscribe-overview.md)
- [Creating a Plan](https://docs.confirmo.net/docs/create-a-plan.md)
- [Creating a Subscription](https://docs.confirmo.net/docs/creating-a-subscription.md)
- [Subscription Lifecycle](https://docs.confirmo.net/docs/subscription-lifecycle.md)
- [Subscription Webhooks ](https://docs.confirmo.net/docs/subscription-webhooks.md)
- [Managing Subscriptions](https://docs.confirmo.net/docs/managing-subscriptions.md)
- [Updates for Travel Rule](https://docs.confirmo.net/docs/api-updates-for-travel-rule-compliance.md)
- [Confirmo domains & URIs](https://docs.confirmo.net/docs/confirmo-domains.md)
- [IP address whitelisting](https://docs.confirmo.net/docs/ip-address-whitelisting.md)
- [POS Terminal](https://docs.confirmo.net/docs/pos-terminal-1.md)

## API Reference
- [Get Assets](https://docs.confirmo.net/reference/getassets-1.md): Retrieves data about the supported assets
- [Intro to the Confirmo API](https://docs.confirmo.net/reference/intro-to-the-confirmo-api.md)
- [Status codes](https://docs.confirmo.net/reference/status-codes.md)
- [Get Crypto Payment Methods](https://docs.confirmo.net/reference/listcryptopaymentmethods-1.md): Returns a list of merchant's Crypto Payment Methods.
- [Create E-mail Invoice](https://docs.confirmo.net/reference/createemailinvoice-1.md): Creates a new E-mail Invoice that will be sent to the specified e-mail address.
- [Developer resources](https://docs.confirmo.net/reference/developers.md)
- [Get merchant's Invoices](https://docs.confirmo.net/reference/getinvoicesformerchant-1.md): Returns a paginated list of Invoices filtered by the specified criteria.
- [Create new Invoice](https://docs.confirmo.net/reference/createinvoicebymerchant-1.md): Creates a new Invoice for the merchant.
- [Get Invoice details](https://docs.confirmo.net/reference/getinvoicebymerchant-1.md): Retrieves detailed information about a specific Invoice by its ID.
- [Update Invoice fields](https://docs.confirmo.net/reference/patchinvoice-1.md): Partially updates an existing Invoice by modifying only the fields provided in the request body.
- [Create Take Request for expired Invoice](https://docs.confirmo.net/reference/placetakerequest-1.md): Places a Take Request for an Invoice that has expired. A Take Request is a process that allows accepting an underpaid Invoice as paid after its expiration.
- [Confirm Take Request](https://docs.confirmo.net/reference/confirmtakeunderpaymentrequest-1.md): Confirms a previously created Take Request for an expired Invoice. This finalizes the acceptance of payment at the current exchange rate and completes the Take process.
- [Integration tips](https://docs.confirmo.net/reference/integration-tips.md)
- [OpenAPI specification](https://docs.confirmo.net/reference/openapi-specification.md)
- [List Payouts](https://docs.confirmo.net/reference/listpayouts-1.md): Returns list of merchant's Payouts filtered by specific parameters.
- [Create a new Payout](https://docs.confirmo.net/reference/createpayout.md): Creates a new Payout request to transfer funds from merchant account to a specified address.
- [Get Payout details](https://docs.confirmo.net/reference/getpayoutbyid.md): Retrieves detailed information about a specific Payout by its ID.
- [Change status of a Payout.](https://docs.confirmo.net/reference/changepayoutstatus.md): Changes status of payout depending on action provided in request. Note that without opting-in to the new payouts flow, using other actions than CONFIRM and CANCEL will result into an error.
- [Get Settlement Methods](https://docs.confirmo.net/reference/getsettlementmethods-1.md): Returns all merchant's Settlement Methods.
- [List merchant Settlements](https://docs.confirmo.net/reference/getsettlementsformerchant-1.md): Returns list of merchant's Settlements filtered by specific parameters.
- [Get Settlement detail](https://docs.confirmo.net/reference/getsettlementasmerchant-1.md): Retrieves detailed information about a specific Settlement by its ID.
- [Get exchange rates for a specific payment asset](https://docs.confirmo.net/reference/getexchangerates-1.md): Returns current exchange rates from all available source assets to the specified payment asset. Exchange rates are updated once per minute.
- [Get merchant balances](https://docs.confirmo.net/reference/getmerchantbalances-1.md): Returns merchant's balances.
- [List crypto deposits](https://docs.confirmo.net/reference/getdepositspaginated.md): Retrieves a paginated list of crypto deposits with optional filtering by account, address, blockchain network, payment asset code, balance asset code, status, and creation date range.
- [List Crypto Deposit accounts](https://docs.confirmo.net/reference/listcryptodepositaccounts.md): Retrieves a paginated list of Crypto Deposit accounts for the authenticated merchant.
- [Create a Crypto Deposit account](https://docs.confirmo.net/reference/createcryptodepositaccount.md): Creates a new Crypto Deposit account for the authenticated merchant.
- [Get Crypto Deposit account detail](https://docs.confirmo.net/reference/getcryptodepositaccountbyid.md): Retrieves a single Crypto Deposit account, including its deposit addresses and supported payment methods.
- [Update Crypto Deposit account fields](https://docs.confirmo.net/reference/patchcryptodepositaccount.md): Partially updates a Crypto Deposit account.
- [List Crypto Top-Up accounts](https://docs.confirmo.net/reference/listcryptotopupaccounts.md): Retrieves a paginated list of Crypto Top-Up accounts for the authenticated merchant.
- [Create a Crypto Top-Up account](https://docs.confirmo.net/reference/createcryptotopupaccount.md): Creates a new Crypto Top-Up account for the authenticated merchant.
- [Get a Crypto Top-Up account](https://docs.confirmo.net/reference/getcryptotopupaccountbyid.md): Retrieves a single Crypto Top-Up account, including its top-up addresses and supported payment methods.
- [Update Crypto Top-Up account fields](https://docs.confirmo.net/reference/patchcryptotopupaccount.md): Partially updates a Crypto Top-Up account.
- [List crypto top-ups](https://docs.confirmo.net/reference/gettopupspaginated-1.md): Retrieves a paginated list of crypto top-ups with optional filtering by account, address, blockchain network, payment asset code, balance asset code, status, and creation date range.
- [Get fiat top-up instructions](https://docs.confirmo.net/reference/getfiattopupinstructions.md): Returns fiat top-up instructions for every currency the authenticated merchant has set up.  **Prerequisites:** For webhook notifications to be delivered upon top-up detection, the merchant must first configure the `notifyUrl` via the Merchant Settings page in the GUI. If no `notifyUrl` is configured, top-up instructions are still returned but no webhook will be sent.
- [List fiat withdrawals](https://docs.confirmo.net/reference/getwithdrawalspaginated.md): Returns a paginated list of fiat withdrawals for the authenticated merchant.
- [Initiate fiat withdrawal](https://docs.confirmo.net/reference/initiatewithdrawal.md): Initiates a fiat withdrawal from the merchant's balance to a registered bank account.
- [List scheduled fiat withdrawals](https://docs.confirmo.net/reference/listschedules.md): Returns the merchant's schedules ordered from newest to oldest. ACTIVE, PAUSED, and CANCELLED are all returned.
- [Create a scheduled fiat withdrawal](https://docs.confirmo.net/reference/createschedule.md): Configures a recurring sweep of the merchant's fiat balance to a registered bank account. On success returns the newly created schedule in status ACTIVE.
- [Delete a scheduled fiat withdrawal](https://docs.confirmo.net/reference/deleteschedule.md): Deletes a scheduled fiat withdrawal. Allowed from any non-DELETED state (ACTIVE, PAUSED, CANCELLED).
- [Get a scheduled fiat withdrawal by ID](https://docs.confirmo.net/reference/getschedule.md): Returns a single schedule by its ID. Returns 404 for deleted or missing schedules and for schedules that do not belong to the caller's merchant.
- [Update a scheduled fiat withdrawal](https://docs.confirmo.net/reference/updateschedule.md): Updates frequency, frequency day, and minimum balance on a schedule. Allowed only from ACTIVE or PAUSED; rejected from CANCELLED. Returns 404 for deleted or missing schedules. The next scheduled run will be recalculated when frequency or frequency day changes.
- [Pause a scheduled fiat withdrawal](https://docs.confirmo.net/reference/pauseschedule.md): Moves an ACTIVE schedule to PAUSED and cancels its next scheduled run. Calling pause on a schedule that is already PAUSED returns the current state without further effect. Rejected with 400 from CANCELLED. Returns 404 for deleted or missing schedules.
- [Resume a scheduled fiat withdrawal](https://docs.confirmo.net/reference/resumeschedule.md): Moves a PAUSED schedule back to ACTIVE and recomputes its next scheduled run. Re-runs validations (withdrawal account still whitelisted, currency still supported, frequency and minimum balance still valid) and rejects the resume with 400 when any check fails. Calling resume on a schedule that is already ACTIVE returns the current state without further effect. Rejected with 400 from CANCELLED. Returns 404 for deleted or missing schedules.
- [List runs for a scheduled fiat withdrawal](https://docs.confirmo.net/reference/listruns.md): Returns the run history for a single schedule, ordered from newest to oldest. Returns 404 when the schedule does not exist or does not belong to the caller's merchant.
- [List fiat withdrawal accounts](https://docs.confirmo.net/reference/getaccounts.md): Returns all fiat withdrawal accounts for the authenticated merchant.
- [Create a fiat withdrawal account](https://docs.confirmo.net/reference/createfiatwithdrawalaccount.md): Creates a new fiat withdrawal account for approval.
- [Delete a fiat withdrawal account](https://docs.confirmo.net/reference/deleteaccount.md): Deletes a fiat withdrawal account. The account must be owned by the authenticated merchant and not already deleted.
- [Create a subscription plan](https://docs.confirmo.net/reference/createplan.md): Create a plan your subscribers can subscribe to.
- [List your subscription plans](https://docs.confirmo.net/reference/listplans.md): Returns all your plans, newest first, regardless of status. Use the `nextCursor` from the previous response to fetch the next page.
- [Get a subscription plan by ID](https://docs.confirmo.net/reference/getplan.md)
- [Archive a subscription plan](https://docs.confirmo.net/reference/archiveplan.md): Archived plans can't be subscribed to, but existing subscriptions on the plan continue billing unchanged. Archiving is one-way and idempotent.
- [Create a subscription](https://docs.confirmo.net/reference/createsubscription.md): Subscribes a subscriber (by email) to one of your plans. Starts in `PENDING` until the subscriber completes checkout. Pass `customerProfile` to supply Travel Rule / AML customer data.
- [List your subscriptions](https://docs.confirmo.net/reference/listsubscriptions.md): Returns your subscriptions, newest first. Use the filters to narrow by status, `customerProfileId`, or createdAt window.
- [Get a subscription by ID](https://docs.confirmo.net/reference/getsubscription.md)
- [Cancel a subscription](https://docs.confirmo.net/reference/cancelsubscription.md): Stops future billing. Idempotent — canceling an already-canceled subscription returns its current state. A subscription that has already expired cannot be canceled (`409`).
- [List payments](https://docs.confirmo.net/reference/listpayments.md): Returns payments across all your subscriptions, newest first. Use the filters to scope to a single subscription, restrict by status, or restrict to a createdAt window.
- [Get a payment by ID](https://docs.confirmo.net/reference/getpayment.md)
- [Merchant Webhook Integration Guide](https://docs.confirmo.net/reference/merchant-webhook-integration-guide.md)
- [A subscription was created](https://docs.confirmo.net/reference/subscriptioncreatedevent.md): Sent when a subscription is created. It usually starts in `PENDING` while the subscriber completes checkout. `payload.data` is the full `Subscription`.
- [A subscription became active](https://docs.confirmo.net/reference/subscriptionactivatedevent.md): Sent when a subscription becomes `ACTIVE` — the subscriber has completed checkout and billing is now on schedule. `payload.data` is the full `Subscription`.
- [A subscription became past due](https://docs.confirmo.net/reference/subscriptionpastdueevent.md): Sent when a charge fails and the subscription enters `PAST_DUE`. Billing retries during the grace period before a terminal state. `payload.data` is the full `Subscription`.
- [A past-due subscription recovered](https://docs.confirmo.net/reference/subscriptionresumedevent.md): Sent when a `PAST_DUE` subscription recovers — a retry succeeded within the grace period and billing is `ACTIVE` again. `payload.data` is the full `Subscription`.
- [A subscription was canceled](https://docs.confirmo.net/reference/subscriptioncanceledevent.md): Sent when a subscription is canceled before its natural end. See `payload.data.cancellation.reason` for who canceled it and why. `payload.data` is the full `Subscription`.
- [A subscription expired](https://docs.confirmo.net/reference/subscriptionexpiredevent.md): Sent when a subscription ends naturally — its fixed term completed, or payment retries were exhausted. See `payload.data.expiration.reason`. `payload.data` is the full `Subscription`.
- [A recurring charge succeeded](https://docs.confirmo.net/reference/subscriptionpaymentsucceededevent.md): Sent when a recurring charge settles successfully. `payload.data` is the `Payment` record; `payload.entityId` is the parent subscription.
- [A recurring charge failed](https://docs.confirmo.net/reference/subscriptionpaymentfailedevent.md): Sent when a recurring charge fails to settle. `payload.data` is the `Payment` record; see `payload.data.failureReason`. `payload.entityId` is the parent subscription.

## Recipes
- [Validate webhook signature](https://docs.confirmo.net/recipes/validate-webhook-signature.md)