Cryptopay API
  • Welcome
  • Guides
    • Introduction
    • Environments
    • Creating a Test Account
    • API Credentials
    • API Basics
      • Responses
      • Date formats
      • Authentication
        • How it works
        • Signature
        • Creating a signature. Code samples
      • Callbacks
    • API Client Libraries
    • API Reference
    • Cryptocurrency Payments
    • Currencies
      • Supported Currencies
      • Currency Icons
    • Confirmations
    • Tools for accepting payments
    • Prebuilt integrations
      • E-commerce payment plugins
      • Payment and software providers
    • Channels
      • Channel payment
      • Payment statuses
      • Channel payment sequence
      • Create a Channel
      • Visual representation at Cashier
      • Channel hosted page
      • Channel payment callbacks
    • Invoices
      • Invoice statuses
      • Invoice payment sequence
      • How to handle unresolved invoices
        • Underpaid
        • Overpaid
        • Paid late
        • Illicit resource
        • Invoice refunds sequence
      • Create an invoice
      • Visual presentation at Cashier
      • Invoice hosted page
      • Online checkout
        • How-to
      • Payment links
      • Invoice callbacks
    • Payouts
      • Payout statuses
      • Payout sequence
      • Payout fees consideration
        • Network fees
      • Create a Coin Withdrawal
        • Possible errors
        • Withdrawals from fiat accounts
        • Withdrawals from cryptocurrency accounts
        • high_risk_address error message
      • Visual representation at Cashier
      • Minimum transaction amount
      • Coin Withdrawal callbacks
      • Travel Rule Compliance
    • Email Billing
      • Create an email billing
      • Email billing callbacks
    • Testing
      • Channels
      • Invoices
      • Payouts
    • Risks
    • Customers
    • Transactions types and Statuses
Powered by GitBook
On this page
  • How to use the payment link
  • Parameters
  1. Guides
  2. Invoices

Payment links

PreviousHow-toNextInvoice callbacks

Last updated 6 months ago

Merchants can use payment links instead of custom API integration to accept payments.

Payment link is an invoice-based tool which can be flexibly integrated into payment and sales scripts.

Examples of usage:

  • The "Payment by Crypto" button from the shopping cart

  • QR code for cryptocurrency payment on the web, a PDF or a paper version of the invoice

  • Sending the payment link to an online chat while talking to the client.

Here is an example of a 10 USD payment link:

How to use the payment link

  1. Log in to your Cryptopay Business account

  2. Navigate to Integration → Online checkout

  3. Generate a new key

  4. Create a link with the required GET parameters

  5. Provide a link to the customer to make a payment.

To create a link, please use the domain depending on the environment:

Environment
URL

Sandbox

Production

Parameters

Parameter
Type
Usage
Description

widgetKey

string

Required

Your widget key

priceAmount

number (double)

Required

Purchase amount

priceCurrency

string

Required

Purchase currency

customId

string

Optional

Purchase reference ID in your system

successRedirectUrl

string

Optional

URL of the page the user will be redirected to if the payment is successful.

unsuccessRedirectUrl

string

Optional

URL of the page the user will be redirected to in case of an error.

description

string

Optional

Purchase description

name

string

Optional

Purchase name

locale

string

Optional

Can be en, de, fr, es, pt, ru and jp which means English, German, French, Spanish, Portuguese, Russian or Japanese language.

If parameter is not set, the language will be taken from the browser settings.

https://pay-business-sandbox.cryptopay.me/?widgetKey=f2a94888-9b4b-42e0-b35f-d5825002e830&priceAmount=10&priceCurrency=USD
https://pay-business-sandbox.cryptopay.me
https://business-pay.cryptopay.me