Charges

Charges represent a payment by your users, and have a wealth of data associated with it. Each charge has an associated checkout, which is a hosted page where a user can perform the payment. You'll need to redirect your users there so they can pay the charge. Note that charges (and it's associated checkouts) expire after a determined amount of time. Any payment done after the expiry of the charge will be refused.

NOTE

To understand the difference between PAID and CONFIRMED status later on, just bear in mind that a PAID orders mean that the payment was sent, while CONFIRMED means the payment is successful and the funds are in your account. If you are familiar with credit cards payment processing, they are the equivalent to AUTHORIZED and CAPTURED payments using credit cards.

Note that, contrary to usual fiat working, cryptocurrency payments can't be reversed. Once the funds hit your account, they are yours and can't be taken away.

Create charge

To request a cryptocurrency payment, you create a charge. Since cryptocurrency payments are push payments, a charge will expire after a waiting period (payment window) if no payment has been detected. Charges are identified by a unique code.

HTTP Request

https://app.gitbook.com/o/IqKLoXoEzDBbZy1LIFHy/s/RvqwWtIE7EFiyevKMP2T/criptan/business/charge

TIP

Your metadata object has to be stringifable. If it is not, charge creation will fail.

Generate QR code

If you don't want to use the provided payment page, you can use the data received from charge creation to generate a QR code and address for payment. The procedure depends on each coin, but for BTC (the only accepted coin at this time) you can use the following with any QR code generator:

// Data is data received from creating a charge
const data = {
  address: '3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5',
  amount: '1'
}

const qrCode = bitcoin:${data.address}?amount=${data.amount}

You don't need to include sending fees: they are automatically included when the user scans the wallet, which allows the wallet to generate the fees dynamically.

WARNING

If you alter the amount field from the response when you generate the payment, the system will either register the charge as underpaid (if lowering the amount) or the amount overpaid (if making the amount bigger) will be lost!

Note that if you aren't careful, the amounts can cause rounding errors in certain programming languages.