BusinessCharge

Charge entity. This is the type that is returned in API responses.

Property	Description	Type	Optional
acceptanceRate	Amount of the acceptance fee (EUR) that a merchant chooses to accept less for each payment	string	Yes
cancelUrl	Url to redirect once change expired	string	No
checkoutUrl	Url of the payment details	string	No
client	Client (user) that pays the charge	BusinessChargeClient	Yes
confirmedAt	Charge confirmation date	string	Yes
continueUrl	Url to redirect once change is paid	string	No
createdAt	Charge creation date	string	No
cryptoHoldingPercentage	Percentage (0-100) that indicate how much the charge is converted to fiat: 0 - nothing is sell 100 - all crypto is sell into fiat	string	Yes
description	Charge description	string	No
expiresAt	Charge expiration date	string	No
id	Identifier	string	No
metadata		string	Yes
paidAt	Charge paid date	string	Yes
processStatus	Charge processing status	string: "ERROR" | "INITIATED" | "PROCESSED" | "UNPROCESSED"	No
paymentStatus	Charge payment status	string: "CONFIRMED" | "DELAYED" | "EXPIRED" | "PAID" | "PENDING" | "REFUNDED" | "UNDERPAID"	No
processedAt	Charge processed date	string	Yes
products	Charge products list	[BusinessProduct]	No
pricing	Charge pricing information	BusinessPricing	No
refundAddresses	Refund addresses information	BusinessRefundAddress	Yes
refundPaidAt	Charge refund paid date	string	Yes
refundRequestedAt	Charge refund requested date	string	Yes
transaction	Charge received transaction information	BusinessTransaction	Yes
userId	userId that created the charge	string	No

Subtypes

BusinessTransaction

Property	Description	Type	Optional
amount	Transaction amount	string	No
confirmations	Number of confirmations of transaction in blockchain	number	No
currency	Transaction currency	string: 'BTC' | 'ETH' | 'LTC' | 'USDC'	No
isInternal	Flag that indicates if transaction is internal	Boolean	No
id	Transaction id	string	No

BusinessRefundAddress

This item will be returned when a payment is obtained, if the payment has previously been refunded from the Criptan Pay panel.

Property	Description	Type	Optional
address	Address to return the payment	string	No
amount			No
currency	currency to return	string: 'BTC' | 'ETH' | 'LTC' | 'USDC'	No

BusinessProduct

This object contains the information of each product of a payment.

Property	Description	Type	Optional
description	Product description	string	Yes
image	Product image	string	Yes
price	Product unit price	number	No
quantity	Product quantity	number	No
title	Product name	string	No

BusinessPricing

This object contains the following structure for BTC, ETH and LTC:

Property	Description	Type	Optional
address	Address to receive the payment	string	No
amount	Charge total amount	string	No
price	Currency market price	string	No
currency	Pricing currency	string: "BTC" | "ETH" | "LTC"	No

And for FIAT follow the next structure:

Property	Description	Type	Optional
amount	Charge total amount	string	No
currency	currency	string: "EUR"	No

BusinessChargeClient

Property	Description	Type	Optional
address	Client address	string	No
dateOfBirth	Client date of birth	string	No
document	Client id document	{ id: string, type: string }	No
fullName	Client full name	string	No