Create links to receive online card payments on behalf of a business.
Use this Javascript SDK to create unique links to an online checkout page where a visitor can pay. The business must visit the checkout page once created to finish configuring the system.
The checkout page, the payment gateway, the country compliance and the transfers are handled by Stripe.
Install the package with:
npm install qrpayments --save
To create a new link to a payment checkout page, call createCheckout with an array of items:
import { QrPayments } from "qrpayments"
const client = new QrPayments();
client.createCheckout([{
name: "Carrot Cake",
currency: "usd",
quantity: 1,
amount: 450, //amount in cents
}])The line item object:
- name: The name for the line item.
- amount: The amount to be collected per unit of the line item.
- currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- quantity: The quantity of the line item being purchased.
- description: (Optional) The description for the line item.
- images: (Optional) A list of images (urls) representing this line item.
The response object:
{
"id":"dAg7bJdHnnC6599tBraA",
"url":"https://payqr.page.link/ikWb",
"ready":false,
"line_items":[{
"name":"Carrot Cake",
"amount":450,
"currency":"usd",
"quantity":1
}],
}The property ready is set to false by default and you must redirect the business to the url property in order to
finish the business setup flow. Once the business finish the setup flow, the ready property is set to true and the
url displays the checkout page.
Retrieve a existing checkout link:
import { QrPayments } from "qrpayments"
const client = new QrPayments();
client.getCheckout("dAg7bJdHnnC6599tBraA")The response object is the same created in createCheckout:
{
"id":"dAg7bJdHnnC6599tBraA",
"url":"https://payqr.page.link/ikWb",
"ready":true,
"line_items":[{
"name":"Carrot Cake",
"amount":450,
"currency":"usd",
"quantity":1
}],
}