SubScrypt API

Sections

Theme switcher

SubScrypt API

On this page
  • SubScrypt API

Accounts, API Keys & Webhooks

Accounts are the basic organizations that use Coinsub services. They can be individuals, businesses, or non-profit organizations. They can have one or more users associated with them, and they can be connected to other accounts.

Creating an account through the API will connect that account with your account, enabling you to call the API as that account in the future. This allows a platform account the ability to onboard users, and configure products, and payment agreements for their users.

On this page
  • Accounts, API Keys & Webhooks

Merchant Wallet Transfers

Subscrypt Merchant Wallets are secure, non-custodial wallets powered by DFNS’s battle-tested wallet infrastructure. Designed with robust key management and WebAuthn-based authentication, these wallets ensure enterprise-grade security without exposing private keys or relying on vulnerable seed phrases. With Merchant Wallets, Subscrypt merchants don’t need to connect external wallets or manage third-party integrations. Everything is built-in—making on-chain payments, managing funds, and receiving crypto subscriptions frictionless and secure, straight from your Subscrypt dashboard.

To get started with a merchant platform wallet of your own, sign up at test.subscrypt.solutions (development environment) or app.subscrypt.solutions (production).

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Merchant Wallet Transfers

Wallet Credentials

Merchant wallets on our platform support two types of credentials:

  1. FIDO2 / Passkeys FIDO2 credentials (commonly referred to as passkeys) offer a secure, passwordless authentication method based on public key cryptography. These credentials are typically linked to a user and stored in secure authenticators (e.g., platform authenticators like Face ID, or external security keys). Upon sign up, a default passkey will be added to your platform account.
  2. Platform Key Credentials Platform Key Credentials are asymmetric key pairs managed and operated by the platform

How These Types of Keys Work Together

When you sign up for the platform, a Platform Key Credential is automatically created for you. This key, managed by the platform, allows for secure, programmatic signing operations and comes with a default transaction allowance of $100.

As an added layer of protection, once your wallet balance exceeds $10, you'll be required to set up a Passkey (FIDO2 credential). Passkeys are tied to your personal device and identity - using technologies like Face ID or security keys - to provide passwordless, phishing-resistant authentication.

By combining both key types, our platform ensures seamless and secure usage with platform-controlled keys, while strengthening your account security through user-bound passkeys as your account value increases.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Wallet Credentials

Wallet Transfers

Traditionally, sending crypto funds requires users to pay gas fees using the native token of the blockchain they're operating on — for example, ETH on Ethereum or MATIC (POL) on Polygon. This can be a barrier, especially for users who don’t already hold these tokens.

To improve the user experience, we’ve introduced gasless transfers — a simple and seamless way to send funds without needing to hold or spend native tokens. This makes transactions faster, easier, and more accessible for all users.


How Our Gasless Transfers Work

Gasless transfers on our platform can be executed in two different ways:

1. Platform-Signed Transfers

In this mode, the Platform handles the transaction signature on behalf of the Merchant. The Merchant grants the Platform permission to sign transfers up to a specified threshold (e.g. $100 per transfer). If a transfer exceeds this threshold, the Platform will request a manual signature from the Merchant before proceeding. This setup is ideal for minimizing operational friction while maintaining control over large or sensitive transfers.

2. Merchant-Signed Transfers

Alternatively, the Merchant can handle the signing process directly, maintaining full control over every transaction. In this case, each transfer must be individually approved and signed by the Merchant's Passkey.


Security Restrictions

To protect users from potential abuse or unauthorized activity, gasless transfers are only permitted between wallets registered within our system. This ensures traceability, accountability, and reduces the risk of fraud or phishing attempts.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Wallet Transfers

Create Transfer Request

To initiate a new transfer you must provide the following parameters:

  • to_address: The recipient’s email address (must be registered with our platform) or wallet - Use the same email used when creating a purchase session.
  • amount: Amount of tokens to transfer
  • chainId: ID of the target blockchain.
  • token: Symbol of the token being transferred (e.g., USDC, USDT, PYUSD)

This endpoint transfers funds directly to the recepieng without requiring any signatures from the merchant. If the amountexceeds the allowance set at wallet security page, the API would not process the transfer.


Important Notes

⚠️ The recipient's email must be registered with our platform to prevent unauthorized or accidental transfers.

⚠️ chainIdvalues for the TEST ENVIRONMENT are:

  • 80002 for Polygon
  • 84532 for Base
  • 11155111 for Ethereum

⚠️ chainIdvalues for the PRODUCTION ENVIRONMENT are:

  • 137 for Polygon
  • 8453 for Base
  • 1 for Ethereum
Was this section helpful?

What made this section unhelpful for you?

On this page
  • Create Transfer Request

When a Signature is Required

This endpoint transfers funds directly to the recipient without requiring any signatures from the merchant. However, if the transfer amount exceeds the allowance set on the Wallet Security page, the API will not process the transfer.

If your API transfers regularly exceed the default limit of $100, you have two options:

  1. Increase the allowance on the platform
  2. Navigate to Settings → Wallet Security → Grant/Transfer Permission
  3. Update the allowance to the amount you require

OR

  1. Send the Transfer Using the Wallet UI
  2. Go to the Wallet page, locate the token you want to send, and click the Send button next to it.
  3. Enter the desired amount and the recipient's wallet address or email.
Was this section helpful?

What made this section unhelpful for you?

On this page
  • When a Signature is Required

Subscription Products

On this page
  • Subscription Products

Agreements

On this page
  • Agreements

Payments

On this page
  • Payments

Purchase Sessions

On this page
  • Purchase Sessions

Purchase Messages

On this page
  • Purchase Messages

Permit Messages

On this page
  • Permit Messages

Integration Options

This comprehensive guide provides detailed information about integrating Coinsub payment processing into your application. Coinsub offers four distinct integration methods designed to accommodate different technical requirements and use cases, from simple no-code solutions to advanced API integrations with full customization capabilities.

Option
Integration Level
Customization
Hosted Checkout UI

1. Standard Checkout Link

🔹 No Code

✅ (full control)

2. Button Embed

🔸 Low Code

✅ (button color)

3. iFrame Embed

🔸 Medium Code

✅ (full control)

4. Headless API

🔸 Developer

✅ (fully programmable)


Which Integration Option Should You Use?

Choosing the right integration depends on your technical resources, business model, and how much control you want over the checkout experience.

🔹 Standard Checkout Link – Best for Non-Technical Merchants

Who it's for:

  • Individual creators
  • Small merchants or service providers
  • Teams with no dev resources

Why use it:

  • Zero development required
  • Shareable across any platform (email, social, website)
  • Fastest way to start accepting stablecoin payments

🔸 Button Embed – Best for Low-Code Teams

Who it's for:

  • Marketing teams with light dev help
  • Shopify, WordPress, or Webflow users
  • Sites that need a call-to-action button with minimal backend setup

Why use it:

  • Simple HTML embed
  • Button styling via data-color
  • Redirects to secure hosted checkout

🔸 Modal iFrame – Best for Custom Frontends That Want In-Site UX

Who it's for:

  • Sites with web developers
  • Businesses that care about seamless branding and user experience
  • Publishers, SaaS sites, or gated content platforms

Why use it:

  • Fully embedded experience
  • Controlled modal styling
  • Checkout stays within your UI context

🔸 Headless API – Best for Crypto-Native Platforms & Advanced Teams

Who it's for:

  • Web3 apps, dApps, DeFi platforms
  • Teams already managing wallets or signing flows
  • Platforms needing custom onboarding, wallet UX, or nonstandard product logic

Why use it:

  • Full control over the payment process
  • You manage wallet interaction and signing
  • Suitable for integrations with other on-chain or backend systems
On this page
  • Integration Options

Webhooks

Webhooks allow real-time communication between systems.

Webhooks are used to synchronize disparate systems by publishing automated messages with predefined payloads that can be interpreted by integrated systems. They allow real-time communication between applications, enabling instant updates and data sharing without the need for continuous polling.

Our platform webhooks provide notifications when specific actions occur on your account, such as when a customer subscribes to a product, purchases a one-off product, makes a payment, or cancels a subscription. By setting up webhooks, you can automate processes and keep your systems in sync with our platform in real-time.

On this page
  • Webhooks

Test Customer Demand for Crypto Payments

The Crypto Interest & Engagement Button allows you to measure customer interest in paying with cryptocurrency before launch. By integrating this button, you can collect customer interactions, emails, and waitlist sign-ups—all without processing any payments immediately.


How It Works

  1. Customer clicks “Pay with Crypto” The button records the interaction in our database.
  2. Modal opens A pop-up asks the customer if they want to receive updates via email.
  3. Customer enters email They are added to your “waitlist” for crypto payments.
  4. You get data Track interest, cart sizes, and popular products.

Step 1 – Get Your Merchant ID

  1. Log in to your CoinSub Dashboard.
  2. Go to Settings → API Keys.
  3. Copy your Merchant ID.

Step 2 – Add the Script to Your Website

Place the following script anywhere in your HTML:

HTML

Step 3 – Customize Button (Optional)

The button can be fully customized using the data-* attributes. Here’s what each field does. You can customize the look of your buttons to match your website’s style. You can find real code examples here.

Attribute

Required

Description

Example

data-merchant-id

✅ Yes

Your unique Merchant ID from CoinSub.

"b8690aab-2202-4ed5-abf7-02f4661e0925"

data-button-text

⚙️ Optional

Text displayed on the button.

"Subscribe with Crypto ⚡"

data-background-color

⚙️ Optional

Background color of the button block. Accepts HEX or RGB.

"rgb(30,30,30)"

data-button-color

⚙️ Optional

Button color.

"rgb(0,200,200)"

data-button-text-color

⚙️ Optional

Color of the text on the button.

"rgb(255,255,255)"

data-logo-mode

⚙️ Optional

Logo style (dark or white).

"dark"

data-cart-size

⚙️ Optional

The total cart value associated with this product.

99.99

data-merchant-industry

⚙️ Optional

Your business category.

"Fashion"

data-product-metadata

⚙️ Optional

Product details in JSON format.

'{"product_name": "Skirt", "price": 99.99, "category": "clothing"}'


Step 4 – Collect Data & Analyze

For the APIs you can use to collect data about user engagement/interest use the following set of APIs. This feature is currently restricted to the test environment.

On this page
  • Test Customer Demand for Crypto Payments