Email Invoice

Create E-mail Invoice

Creates a new E-mail Invoice that will be sent to the specified e-mail address.

post/v3/email-invoices

Request

Base URL
https://confirmo.net/api
URL
https://confirmo.net/api/v3/email-invoices
Auth
HTTP bearer

Request body

sendEmailCopyboolean

If true, a copy of the generated e-mail will be sent to the merchant's inbox

targetEmailstring email required

The e-mail address where this E-mail Invoice should be sent

Example request

{
  "invoice": {
    "customerEmail": "customerEmail@email.com",
    "customerProfile": {
      "city": "Springfield",
      "country": "US",
      "postalCode": "90210",
      "profileId": "profile-12345",
      "streetAddress": "123 Main Street",
      "lei": "5493001KJTIIGC8Y1R12",
      "registeredName": "ACME Inc.",
      "registrationNumber": "12345678"
    },
    "invoice": {
      "currencyFrom": "EUR",
      "paymentMethodId": "BITCOIN-BLOCKCHAIN-MAINNET-BTC-CURRENCY"
    },
    "notifyEmail": "orderReceived@yourEShop.com",
    "notifyUrl": "https://yourEShop.com/orderReceived",
    "product": {
      "description": "Small silver computer",
      "name": "Computer"
    },
    "reference": "anything",
    "returnUrl": "https://yourEShop.com/orderReceived",
    "settlement": {
      "currency": "EUR"
    }
  },
  "sendEmailCopy": true,
  "targetEmail": "customer@example.com"
}

Response

E-mail Invoice successfully created

createdAtinteger

customerCurrency'BNB' | 'BTC' | 'ETH' | 'EURC' | 'LTC' | 'POL' | 'SOL' | 'TRX' | 'USAT' | 'USDC' | 'USDG' | 'USDT' | 'XPL' | 'AED' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BDT' | 'BGN' | 'BHD' | 'BND' | 'BOB' | 'BRL' | 'BYN' | 'CAD' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DKK' | 'DOP' | 'DZD' | 'EUR' | 'FKP' | 'GBP' | 'GEL' | 'GTQ' | 'HKD' | 'HRK' | 'HUF' | 'CHF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JPY' | 'KGS' | 'KHR' | 'KWD' | 'KZT' | 'LTL' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'PEN' | 'PHP' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UAH' | 'USD' | 'UYU' | 'VND' | 'XCD'

The currency in which the customer is supposed to pay.

idstring

The E-mail Invoice ID.

merchantAmountnumber required

The original E-mail Invoice amount.

merchantCurrency'BNB' | 'BTC' | 'ETH' | 'EURC' | 'LTC' | 'POL' | 'SOL' | 'TRX' | 'USAT' | 'USDC' | 'USDG' | 'USDT' | 'XPL' | 'AED' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BDT' | 'BGN' | 'BHD' | 'BND' | 'BOB' | 'BRL' | 'BYN' | 'CAD' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DKK' | 'DOP' | 'DZD' | 'EUR' | 'FKP' | 'GBP' | 'GEL' | 'GTQ' | 'HKD' | 'HRK' | 'HUF' | 'CHF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JPY' | 'KGS' | 'KHR' | 'KWD' | 'KZT' | 'LTL' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'PEN' | 'PHP' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UAH' | 'USD' | 'UYU' | 'VND' | 'XCD' required

The original E-mail Invoice currency.

notifyUrlstring

The URL where webhooks will be POSTed.

paymentLinkstring

URL of the payment link included in the generated E-mail Invoice

referencestring

Any data the merchant wishes to store in the invoice. It might be, for instance, a JSON or any other string identifying the invoice in the merchant's system. The maximum length is 512 characters.

sendEmailCopyboolean

Indicates whether a copy of the generated e-mail was sent to the merchant

settlementCurrency'BTC' | 'CZK' | 'ETH' | 'EUR' | 'GBP' | 'HUF' | 'LTC' | 'PLN' | 'POL' | 'SOL' | 'TRX' | 'USD' | 'USDC' | 'USDT' required

The currency in which the Settlement will be paid out. Merchant gets paid in this currency, when it is assigned to an invoice as settlement currency

status'ACTIVE' | 'PAID' | 'EXPIRED'

Current status of the E-mail Invoice.

Example response

{
  "createdAt": 1484055304,
  "customer": {
    "clicks": 1,
    "email": "customer@example.com"
  },
  "customerCurrency": "LTC",
  "id": "emio7g928e36",
  "merchantAmount": 100,
  "merchantCurrency": "EUR",
  "notifyUrl": "https://yourEShop.com/orderReceived",
  "paymentLink": "https://pay.confirmo.com/public/email-invoice/asdfkeUizoasZLasdtZxXzsdIITkiawBGba?merchantId=sdafaouvreiuh",
  "product": {
    "description": "Small silver computer",
    "name": "Computer"
  },
  "sendEmailCopy": true,
  "settlementCurrency": "EUR",
  "status": "expired"
}

Changes

No recorded changes to this operation across all 1 revision of this API.