Retrieve an Invoice by ID

Invoice id

Indicates whether to return information about Merchant, Metadata, Notes to recipient and email delivery settings

the CoinPayments id for the invoice

the optional API caller provided external invoice number. Appears in screens shown to the Buyer and emails sent.

the optional numeric suffix for the CoinPayments.Services.Merchants.Dtos.InvoiceResponseDto.InvoiceId. Used when the invoice is emailed to multiple customers

the timestamp when the invoice was created

the date of the invoice, either the system created date or custom date specified by the merchant

optional due date of the invoice

the timestamp when the invoice was confirmed (paid)

the timestamp when the invoice was completed (paid out to the merchant and CoinPayments fees)

the timestamp when the invoice was manually cancelled. Applicable for payment invoices only

the timestamp when the invoice expires. Applicable for checkout and POS invoices only

the currency the invoice is in

the merchant the invoice is for

options to show/hide merchant information on an invoice, or include additional merchant information specific to an invoice

the buyer information, if not provided it will be requested during payment so that refunds can be sent if there is a problem with the payment.

the purchase description

the total amount of the invoice, with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance and discounts, if any

the shipping method and address

any custom data the caller wishes to attach to the invoice which will be sent back in notifications

the status of the invoice (including payments received and payments confirmed)

flag indicating whether a buyer name and email are required, they will be requested at checkout if not provider by the caller. The CoinPayments.Services.Merchants.Dtos.InvoiceResponseDto.BuyerDataCollectionMessage will be displayed to the buyer when prompted.

the message to display when collecting buyer user data

notes for the merchant only, these are not visible to the buyers

any additional information to share with the buyer about the transaction

any terms and conditions, e.g. a cancellation policy

the invoice email delivery options if the invoice is to be emailed

indicates if invoice was delivered by email or to be delivered by email

the invoice metadata, the integration and host where the invoice was created

The merchant's purchase order (PO) number for the invoice. Must be unique per merchant

Provides details related to the payouts associated with the invoice.

Invoice in finished state more than 90 days

Flag for hiding icon on the checkout app

The URL to which the buyer will be redirected after successful payment of the invoice

The URL to which the buyer is redirected if the invoice is canceled