Payment links

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: https://pay-business-sandbox.cryptopay.me/?widgetKey=f2a94888-9b4b-42e0-b35f-d5825002e830&priceAmount=10&priceCurrency=USD.

  1. Log in to your Cryptopay Business account

  2. Navigate to Settings → Widget

  3. Generate a widget 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:

Parameters

ParameterTypeUsageDescription

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.

theme

string

Optional

Controls the color design. light (by default) or dark.

Last updated