/merchant/invoices/buy-now-buttonGenerate a "Buy Now" Button
postMerchantInvoicesBuyNowButtonV2https://a-api.coinpayments.net/api/v2/merchant/invoices/buy-now-buttonRequest
Body schema · JSONcurrencystringCurrency of the invoice items and amount
customIdstringnullablethe API caller provided external ID for the item. Appears on the Merchant dashboard and reports only.
skustringnullablethe stock keeping unit (SKU) of the item
namestringthe name or title of the item
descriptionstringnullablethe detailed description of the item
valueintegerthe quantity of the item. Must be greater than 0 and less than 999,999,999. defaults to 1 if not provided.
int32typestringDefines the types of quantities applicable to a line item in the CoinPayments merchant system. It categorizes the quantity as either a measure of time or a specific count.
hoursquantityoriginalAmountstringnullablethe original total price of the item if CoinPayments.Services.Merchants.Dtos.LineItemV2Dto.Amount represents a discounted price
amountstringthe subtotal price of the item (note: this is not a per unit price but the total price for the total quantity)
taxstringnullablethe total taxes charged on this item
subtotalstringthe subtotal for all items, required if the request includes `invoice.items[]` and must be equal to the sum of all `(invoice.items[].amount)` for all items.
shippingstringnullablethe optional shipping fee for all items within the invoice
handlingstringnullablethe optional handling fee for all items within the invoice
taxTotalstringnullablethe total taxes charged on the invoice, required if the request includes `invoice.items[]` with taxes and must be equal to the sum of all `(invoice.items[].tax)` for all items.
discountstringnullablethe optional discount for all items within the invoice
totalstringThe total amount associated with the invoice, encompassing all charges, fees, and adjustments.
hideShoppingCartbooleanIf the field is set to `true` the shopping cart on the checkout app will be hidden
successUrlstringnullablethe url to redirect to once an invoice is successfully paid
cancelUrlstringnullablethe url to redirect to if payment of an invoice fails (e.g. expired) or is cancelled by the user
ipnUrlstringnullablethe url to send a payment complete message to once the invoice has been paid
urinotificationsstring[]Specifies the list of webhook notification types to be triggered for the invoice (buy-now-button).
invoiceCreatedinvoicePendinginvoicePaidinvoiceCompletedinvoiceCancelledinvoiceTimedOutinvoicePaymentCreatedinvoicePaymentTimedOutemailNotificationsbooleanflag indicating whether to send an email notification once payment completes successfully
buttonWidthintegernullablethe desired width of the "Buy Now" button
int32buttonStylestringnullablethe style of the button
useCoinReservationbooleanDetermines whether the invoice reserves the requested stable coin amount during its validity period.
affiliateIdstringnullableUnique identifier for the affiliate associated with the request, if applicable
uuidinvoiceIdstringnullableIf the Invoice ID is provided, the id of the invoice will reference the provided value instead of generating a new unique UUID
uuidtypestringRepresents the type of "Buy Now" buttons that can be generated for Merchant Invoices.
permanentsingleInvoicefromCurrencystringThe buyer selected currency
toCurrencystringthe currency of the wallet or address into which to payout to
addressstringthe external address into which to pay out
frequencystringnormalasSoonAsPossiblehourlynightlyweeklyResponses
200 · 401 · 403string