# Loop Crypto ## Docs - [Cancel agreements](https://docs.loopcrypto.xyz/api/agreements/cancel-agreements.md): Cancels one or more agreements associated with the authenticated entity with a cancellation reason. The request must include a valid API key with appropriate permissions. - [Create agreement](https://docs.loopcrypto.xyz/api/agreements/create-agreement.md): Creates a new agreement associated with the authenticated entity. The request must include a valid API key with appropriate permissions. - [Disconnect agreement from Stripe](https://docs.loopcrypto.xyz/api/agreements/disconnect-agreement-from-stripe.md): Disconnects an agreement from Stripe. Used when a customer switches to paying with a different payment method other than crypto. Note that the user will no longer receive invoice emails from Loop after this has been called - [List agreements](https://docs.loopcrypto.xyz/api/agreements/list-agreements.md): Lists all agreements associated with the authenticated entity. The request must include a valid API key with appropriate permissions. This endpoint is useful for managing multiple agreements. - [Update agreement](https://docs.loopcrypto.xyz/api/agreements/update-agreement.md): Updates the payment method for a specific agreement. The request must include a valid API key with appropriate permissions. - [Create API key](https://docs.loopcrypto.xyz/api/api-keys/create-api-key.md): Creates a new API key for the authenticated entity. The API key can be used to authenticate future requests to the API. The API key will be returned in the response and cannot be retrieved again later, so make sure to store it securely. - [Delete API key](https://docs.loopcrypto.xyz/api/api-keys/delete-api-key.md): Deletes an API key associated with the authenticated entity. The API key will be immediately invalidated and can no longer be used to authenticate requests. This action cannot be undone. If you need to restore access, you will need to create a new API key. - [List API keys](https://docs.loopcrypto.xyz/api/api-keys/list-api-keys.md): Returns a list of API keys associated with the authenticated entity. The list can be filtered by API key ID or name. If no filters are provided, all API keys for the entity will be returned. Note that the actual API key values are not included in the response for security reasons. - [Update API key](https://docs.loopcrypto.xyz/api/api-keys/update-api-key.md): Updates an API key associated with the authenticated entity. You can modify the name and permissions associated with the API key. The actual API key value cannot be changed. If you need to rotate the API key, you should delete the existing one and create a new one. Note that updating an API key name… - [Create Auth Token](https://docs.loopcrypto.xyz/api/authentication/create-auth-token.md): Creates a new JWT authentication token specific to a merchant. The authentication token can be used to in place of the API key to make calls to the customers and payins endpoints. - [Create Checkout Session](https://docs.loopcrypto.xyz/api/checkout-session/create-checkout-session.md): A Checkout Session represents your customer’s session as they pay for one-time purchases or subscriptions through a Checkout Page or API Agreement call.. - [Get checkout session](https://docs.loopcrypto.xyz/api/checkout-session/get-checkout-session.md): Retrieves details of an existing Checkout Session. - [List checkout sessions](https://docs.loopcrypto.xyz/api/checkout-session/list-checkout-sessions.md): Lists all Checkout Sessions associated to the entity. - [Update Checkout Session](https://docs.loopcrypto.xyz/api/checkout-session/update-checkout-session.md): Updates the details of a checkout session. - [Add Stripe API key](https://docs.loopcrypto.xyz/api/connect-stripe/add-stripe-api-key.md): Connects a Stripe account to an entity. The connection requires a valid Stripe API key that can be created in stripe with a specific set of permissions. Stripe prices are automatically imported into the Loop platform. - [Create customer](https://docs.loopcrypto.xyz/api/customers/create-customer.md): Creates a new customer in the system. A customer represents an individual or entity that can make payments to a merchant. The customer record includes the configured payment methods (which include the wallet address and token information). - [Get customer](https://docs.loopcrypto.xyz/api/customers/get-customer.md): Retrieves details of an existing customer, including their associated merchant, payment methods, and reference ID. This endpoint helps verify a customer's payment capabilities and merchant relationships. - [Get merchant customer](https://docs.loopcrypto.xyz/api/customers/get-merchant-customer.md): Retrieves details of an existing customer for a specific merchant, including their payment methods and reference ID for the merchant. This endpoint helps verify a customer's payment capabilities and merchant relationships. - [List customers](https://docs.loopcrypto.xyz/api/customers/list-customers.md): Lists all customers associated with the authenticated entity. The request must include a valid API key with appropriate permissions. Returns a list of customers that can be filtered by various parameters. This endpoint allows you to retrieve and manage your customer base, including viewing their pay… - [Update customer](https://docs.loopcrypto.xyz/api/customers/update-customer.md): Updates an existing customer in the system. The only field that can currently be modified is the customer reference ID (customerRefId), which is an optional external identifier used to link the customer to an external system. If provided, the customerRefId will be updated to the new value. If null i… - [Create entity](https://docs.loopcrypto.xyz/api/entity/create-entity.md): Creates a new entity in the system. An entity represents a business or organization that can interact with the API. Returns the newly created entity details including its unique identifier and root API key. - [Get entity](https://docs.loopcrypto.xyz/api/entity/get-entity.md): Retrieves details of the entity the API key is associated with. The request must include a valid API key with appropriate permissions. This endpoint is useful for verifying entity details and checking the current state of the entity's configuration. - [Update entity](https://docs.loopcrypto.xyz/api/entity/update-entity.md): Updates the details of the entity the API key is associated with. The request must include a valid API key with appropriate permissions. Any changes made through this endpoint will be immediately reflected in the entity's profile - [Send invoice to be processed](https://docs.loopcrypto.xyz/api/invoice--api/send-invoice-to-be-processed.md): Changes the agreement invoice bill date to the current time and sends it to be processed. - [Create merchant](https://docs.loopcrypto.xyz/api/merchants/create-merchant.md): Creates a new merchant in the system. A merchant represents a business or organization that can interact with the API. Returns the newly created merchant details including its unique identifier and root API key. - [Get merchant](https://docs.loopcrypto.xyz/api/merchants/get-merchant.md): Retrieves details of an existing merchant. The request must include a valid API key with appropriate permissions. This endpoint is useful for verifying merchant details and checking the current state of the merchant's configuration. - [List merchants](https://docs.loopcrypto.xyz/api/merchants/list-merchants.md): Lists all merchants associated with the authenticated entity. The request must include a valid API key with appropriate permissions. This endpoint is useful for managing multiple merchants and their configurations. - [Update merchant](https://docs.loopcrypto.xyz/api/merchants/update-merchant.md): Updates the details of an existing merchant. The request must include a valid API key with appropriate permissions. This endpoint is useful for updating merchant details and configurations. - [Create payin](https://docs.loopcrypto.xyz/api/payins/create-payin.md): Creates a new payin in the system. A payin represents a payment made to a merchant. Returns the newly created payin details including its unique identifier and status. - [Get payin](https://docs.loopcrypto.xyz/api/payins/get-payin.md): Retrieves details of an existing payin. The request must include a valid API key with appropriate permissions. This endpoint is useful for verifying payin details and checking the current state of the payin. - [List payins](https://docs.loopcrypto.xyz/api/payins/list-payins.md): Lists all payins associated with the authenticated entity. The request must include a valid API key with appropriate permissions. This endpoint is useful for managing multiple payins and their details. - [Update payin](https://docs.loopcrypto.xyz/api/payins/update-payin.md): Updates an existing payin. The request must include a valid API key with appropriate permissions. This endpoint is useful for updating payin details and checking the current state of the payin. - [Create payment method](https://docs.loopcrypto.xyz/api/payment-methods/create-payment-method.md): Creates a new payment method for a customer to use for making payments. A payment method consists of a wallet and token configuration on a specific network that is linked to a specific customer. - [Delete payment method](https://docs.loopcrypto.xyz/api/payment-methods/delete-payment-method.md): Deletes a payment method configuration. The request must include a valid API key with appropriate permissions. This endpoint is useful for removing payment method configurations that are no longer needed. - [Get payment method](https://docs.loopcrypto.xyz/api/payment-methods/get-payment-method.md): Retrieves details of an existing payment method. The request must include a valid API key with appropriate permissions. This endpoint is useful for verifying payment method details and checking the current state of the payment method. - [List payment methods](https://docs.loopcrypto.xyz/api/payment-methods/list-payment-methods.md): Lists all payment methods associated with the authenticated entity. The request must include a valid API key with appropriate permissions. This endpoint is useful for managing multiple payment methods. - [Update payment method](https://docs.loopcrypto.xyz/api/payment-methods/update-payment-method.md): Updates an attributes of an existing payment method. The request must include a valid API key with appropriate permissions. This endpoint is useful for updating payment method details such as name and default status. - [Create payment type](https://docs.loopcrypto.xyz/api/payment-types/create-payment-type.md): Creates a new payment type configuration that specifies which tokens an entity or merchant will accept as payment. Each payment type defines a specific blockchain network (e.g. Ethereum, Polygon) and token (e.g. USDC, DAI) combination. The payment type is associated with the entity identified by the… - [Default payment types](https://docs.loopcrypto.xyz/api/payment-types/default-payment-types.md): Sets the default payment types for an entity or merchant. Default payment types are used This endpoint updates the default payment type for the entity or merchant, ensuring that the specified token will be the default payment type for the merchant. - [Delete payment type](https://docs.loopcrypto.xyz/api/payment-types/delete-payment-type.md): Deletes a payment type configuration for a specific merchant and token. The request must include a valid API key with appropriate permissions. This endpoint permanently removes the payment type configuration, meaning the specified token will no longer be accepted as payment for the merchant. This op… - [List payment types](https://docs.loopcrypto.xyz/api/payment-types/list-payment-types.md): Lists all payment types configured for the entity associated with the API key. The request must include a valid API key with appropriate permissions. Returns a list of payment types that can be filtered by various parameters. This endpoint is useful for managing which tokens an entity or merchant ac… - [Create payout destination](https://docs.loopcrypto.xyz/api/payout-destinations/create-payout-destination.md): Creates a new payout destination for the entity associated with the API key. A payout destination represents a wallet address where funds can be sent to. Each destination is tied to a specific blockchain network and can be configured as the default destination for that network. The entity can have m… - [Delete payout destination](https://docs.loopcrypto.xyz/api/payout-destinations/delete-payout-destination.md): Deletes an existing payout destination from the system. The request must include a valid API key with appropriate permissions. This endpoint permanently removes the destination. Default payout destinations cannot be deleted. This operation cannot be undone, so it should be used with caution. Once de… - [Get payout destination](https://docs.loopcrypto.xyz/api/payout-destinations/get-payout-destination.md): Retrieves details of an existing payout destination. The request must include a valid API key with appropriate permissions. This endpoint is useful for verifying payout destination details and checking the current state of the destination - [List payout destinations](https://docs.loopcrypto.xyz/api/payout-destinations/list-payout-destinations.md): Lists all payout destinations configured for the entity associated with the API key. The request must include a valid API key with appropriate permissions. Returns a list of payout destinations that can be filtered by various parameters. This endpoint is useful for managing multiple payout destinati… - [Update payout destination](https://docs.loopcrypto.xyz/api/payout-destinations/update-payout-destination.md): Updates an existing payout destination. Currently can only update whether the destination is the default destination for its network. The request must include a valid API key with appropriate permissions. Only the fields provided in the request body will be updated, while the rest of the destination… - [List tokens](https://docs.loopcrypto.xyz/api/tokens/list-tokens.md): Lists all the currently supported tokens. The request must include a valid API key with appropriate permissions. Tokens can be filtered by various parameters. This endpoint is useful for verifying which tokens are available to accept as payment - [Add users](https://docs.loopcrypto.xyz/api/users/add-users.md): Add one or more users and grant them access to the company portal - [Create webhook](https://docs.loopcrypto.xyz/api/webhooks/create-webhook.md): #### Note: If you are *not* using Stripe, please refer to the webhooks available in the Core Webhooks section instead - [Delete webhook](https://docs.loopcrypto.xyz/api/webhooks/delete-webhook.md): #### Note: If you are *not* using Stripe, please refer to the webhooks available in the Core Webhooks section instead - [Generate new webhook secret](https://docs.loopcrypto.xyz/api/webhooks/generate-new-webhook-secret.md): #### Note: If you are *not* using Stripe, please refer to the webhooks available in the Core Webhooks section instead - [Get webhook secret](https://docs.loopcrypto.xyz/api/webhooks/get-webhook-secret.md): #### Note: If you are *not* using Stripe, please refer to the webhooks available in the Core Webhooks section instead - [List webhooks](https://docs.loopcrypto.xyz/api/webhooks/list-webhooks.md): #### Note: If you are *not* using Stripe, please refer to the webhooks available in the Core Webhooks section instead - [Update webhook](https://docs.loopcrypto.xyz/api/webhooks/update-webhook.md): #### Note: If you are *not* using Stripe, please refer to the webhooks available in the Core Webhooks section instead - [Customer Portal](https://docs.loopcrypto.xyz/customer-portal.md) - [Supported fiat currencies](https://docs.loopcrypto.xyz/fiat-countries.md): Loop supports payouts in both crypto and fiat - [Introduction](https://docs.loopcrypto.xyz/index.md): Create an account and learn how to build on Loop - [Key terminology](https://docs.loopcrypto.xyz/key-terminology.md): Below is a list of Loop and crypto terms - [Loop is joining Lead Bank](https://docs.loopcrypto.xyz/news.md) - [Disconnect Loop from your payment system](https://docs.loopcrypto.xyz/payments-roll-off.md) - [Balances and authorization ](https://docs.loopcrypto.xyz/payments/balances-approvals.md) - [Changelog](https://docs.loopcrypto.xyz/payments/changelog.md) - [Chargebee](https://docs.loopcrypto.xyz/payments/chargebee.md) - [Overview](https://docs.loopcrypto.xyz/payments/component-overview.md) - [Create an account](https://docs.loopcrypto.xyz/payments/create-account.md): Create an account and learn how to build on Loop - [Demo and Code Builder](https://docs.loopcrypto.xyz/payments/demo-widget.md) - [Direct payment](https://docs.loopcrypto.xyz/payments/direct.md) - [Manage payment methods web component](https://docs.loopcrypto.xyz/payments/manage-web.md) - [Manage component](https://docs.loopcrypto.xyz/payments/manage-widget.md) - [Merchants](https://docs.loopcrypto.xyz/payments/merchants.md): Integrate payments into a platform or processor - [Custom integration](https://docs.loopcrypto.xyz/payments/no-widget.md): Description of your new file. - [npm Package](https://docs.loopcrypto.xyz/payments/npm.md) - [Overview](https://docs.loopcrypto.xyz/payments/overview.md): Start earning more today - [Payouts](https://docs.loopcrypto.xyz/payments/payouts.md): Settle in fiat or crypto - [React Component](https://docs.loopcrypto.xyz/payments/react.md) - [Recurring payments](https://docs.loopcrypto.xyz/payments/recurring-payment.md): Charge a paymentMethod on file - [Retries and failures](https://docs.loopcrypto.xyz/payments/retries.md): How Loop handles payments - [SDK](https://docs.loopcrypto.xyz/payments/sdk.md) - [Web component](https://docs.loopcrypto.xyz/payments/web.md) - [Configure webhooks](https://docs.loopcrypto.xyz/payments/webhooks.md): Set up webhooks to receive payment status updates. - [Install and initialize](https://docs.loopcrypto.xyz/payments/widget.md) - [How to set get a wallet for testing](https://docs.loopcrypto.xyz/resources/walletTesting.md): A step-by-step guide for getting started with crypto wallets and testnets - [Disconnect Loop from Stripe](https://docs.loopcrypto.xyz/stripe-roll-off.md) - [Balances and authorization](https://docs.loopcrypto.xyz/stripe/balance-auth.md) - [Cancellations](https://docs.loopcrypto.xyz/stripe/cancellations.md) - [Changelog](https://docs.loopcrypto.xyz/stripe/changelog.md): Description of your new file. - [Checkout sessions](https://docs.loopcrypto.xyz/stripe/checkout-sessions.md): Description of your new file. - [Coupons](https://docs.loopcrypto.xyz/stripe/coupons.md) - [Set default tokens](https://docs.loopcrypto.xyz/stripe/default-tokens.md) - [Downgrades](https://docs.loopcrypto.xyz/stripe/downgrades.md) - [Charging for an invoice that is not tied to a Stripe subscription](https://docs.loopcrypto.xyz/stripe/examples/invoice.md): Description of your new file. - [Take payment for a new subscription or purchase](https://docs.loopcrypto.xyz/stripe/examples/new-subscription.md) - [Switch an existing Stripe customer with an existing Stripe subscription to crypto](https://docs.loopcrypto.xyz/stripe/examples/switch.md): Description of your new file. - [Upgrade a subscription and switch to paying by Loop at one time](https://docs.loopcrypto.xyz/stripe/examples/upgrade-switch.md) - [FAQs](https://docs.loopcrypto.xyz/stripe/faqs.md): Answers to common questions - [Create an account](https://docs.loopcrypto.xyz/stripe/getstarted.md): Start getting paid today - [Overview ](https://docs.loopcrypto.xyz/stripe/intro.md): Use Loop in Stripe to start collecting payments today - [Invoices](https://docs.loopcrypto.xyz/stripe/invoices.md): Get paid in crypto for an invoice that is not tied to a subscription - [Payment links](https://docs.loopcrypto.xyz/stripe/payment-links.md) - [Payouts](https://docs.loopcrypto.xyz/stripe/payouts.md): Description of your new file. - [React checkout sessions component](https://docs.loopcrypto.xyz/stripe/react.md): Description of your new file. - [Receipts & notifications](https://docs.loopcrypto.xyz/stripe/receipts.md): Description of your new file. - [Recurring payments](https://docs.loopcrypto.xyz/stripe/recurring-payments.md) - [Reports and analytics](https://docs.loopcrypto.xyz/stripe/reports.md) - [Retries and failures](https://docs.loopcrypto.xyz/stripe/retries.md): Description of your new file. - [Upgrades](https://docs.loopcrypto.xyz/stripe/upgrades.md): Description of your new file. - [Web checkout sessions component](https://docs.loopcrypto.xyz/stripe/web.md): Description of your new file. - [Webhooks](https://docs.loopcrypto.xyz/stripe/webhooks.md) - [Install and initialize](https://docs.loopcrypto.xyz/stripe/widget.md) - [Checkout sessions component](https://docs.loopcrypto.xyz/stripe/widget-intro.md) - [Supported networks & tokens](https://docs.loopcrypto.xyz/tokens-networks.md): Display inline code and code blocks ## OpenAPI Specs - [openapi.stripe](https://docs.loopcrypto.xyz/api/openapi.stripe.json) - [openapi.core](https://docs.loopcrypto.xyz/api/openapi.core.json) - [openapi](https://docs.loopcrypto.xyz/api-reference/openapi.json) ## Optional - [Blog](https://loopcrypto.xyz/blog) - [Dashboard](https://admin.loopcrypto.xyz) - [Customer portal (Stripe only)](https://my.loopcrypto.xyz)