The checkout can be a great tool for your company to quickly charge consumers. With a focus on UX and usability, you can generate a Payment Link and even a QR Code to simplify the process.

The payment link functionality of Primefy allows for various customizations, so be attentive to the possibilities below.

POST Create payment link

https://api.premepay.com/v1/**stores/:id/payment_links**

List of basic parameters

Parameter Type Description Required
title string Link title Yes
description string Link description Yes
amount number Link value in BRL Yes
currency string Currency Yes
paymentTypes array<integer> Payment type Yes, at least one
0 Credit Card
1 Bank Slip (Boleto Bancário)
3 Pix
installments number Maximum installments on Credit Card Yes, 1-12
boletoInstallments number Maximum installments on Bank Slip (Boleto Bancário) Yes, 1-12

If you want to customize functionalities, add the options below

Products

Provide all the products you want to register in the checkout as metadata. It is important to remember that you still need to provide the property amount.

Parameter Type Description
metadata
products Products in the cart
productId Product ID
productName Product name
unitPrice Unit price
quantity Product quantity
productImage Main product image