COconfirmo
Invoice

Get merchant's Invoices

Returns a paginated list of Invoices filtered by the specified criteria.

get/v3/invoices

Request

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

Query parameters

limitstring

Maximum number of the Invoices to return.

offsetinteger required

Number of the Invoices to skip.

order'createdAt,asc' | 'createdAt,desc' | 'customerAmount,asc' | 'customerAmount,desc' | 'merchantAmount,asc' | 'merchantAmount,desc' required

Sort column and order direction separated by comma.

searchStringstring

Search text to filter by the Invoice ID, the customer e-mail, the crypto address, the TXID or the reference.

status'prepared' | 'pending_verification' | 'active' | 'confirming' | 'paid' | 'expired' | 'error' | 'blocked'

Filter by the Invoice status.

createdAtFromstring

Filter by the creation date - start timestamp (Unix epoch in seconds).

createdAtTostring

Filter by the creation date - end timestamp (Unix epoch in seconds).

currencyFrom'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'

Filter by the merchant currency (the original Invoice currency).

amountFromnumber

Filter by the minimum merchant amount.

amountTonumber

Filter by the maximum merchant amount.

currencyTo'BNB' | 'BTC' | 'ETH' | 'EURC' | 'LTC' | 'POL' | 'SOL' | 'TRX' | 'USAT' | 'USDC' | 'USDG' | 'USDT' | 'XPL'

Filter by the customer payment asset.

amountXFromnumber

Filter by the minimum customer payment amount.

amountXTonumber

Filter by the maximum customer payment amount.

sourceType'API' | 'POS'

Filter by the Invoice source type.

posIdstring[]

Filter by POS device IDs (only applicable when sourceType=POS).

exceptionsFirstboolean

When true, Invoices with exceptions will be listed first.

Response

OK

limitinteger

The number of returned items.

offsetinteger

The number of skipped items.

orderstring

The sort column and the order of returned items.

querystring

The searched string in items.

totalCountinteger

The total number of items owned by the merchant.

Example response

{
  "data": [
    {
      "activeSince": 1506080071,
      "address": "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy",
      "buttonInvoiceId": "paby8ngx1eox",
      "closedAt": 1506080071,
      "confirmingSince": 1506080071,
      "createdAt": 1506080071,
      "cryptoTransactions": [
        {
          "confirmations": 6,
          "createdAt": 1594376981,
          "sourceAddresses": [
            "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
            "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy"
          ],
          "txid": "4f13bc54e8df1620f98934078caaa59c7b480f3ed64e9838f5af519f311bb0b1",
          "updatedAt": 1594376981
        }
      ],
      "cryptoUri": "litecoin:mnLU9vBK7L1WY6JNnGYY...Jdjwfnti4Cu9xz?amount=1.00000000",
      "customerAmount": {
        "amount": 1000,
        "currency": "EUR"
      },
      "customerEmail": "customerEmail@email.com",
      "emailInvoiceId": "emi4og3r6g3w",
      "errorSince": 1506080071,
      "expiredSince": 1506080071,
      "flags": {
        "overpaymentResolvable": true
      },
      "id": "invl8em3zdkr",
      "layer2Attributes": {
        "protocolName": "LIGHTNING"
      },
      "merchantAmount": {
        "amount": 1000,
        "currency": "EUR"
      },
      "notifyEmail": "orderReceived@yourEShop.com",
      "notifyUrl": "https://yourEShop.com/orderReceived",
      "paid": {
        "currency": "LTC"
      },
      "paidSince": 1506079178,
      "paymentMethodId": "BITCOIN-BLOCKCHAIN-MAINNET-BTC-CURRENCY",
      "pendingVerificationSince": 1506080071,
      "preparedSince": 1506080071,
      "product": {
        "description": "Small silver computer",
        "name": "Computer"
      },
      "rate": {
        "currencyFrom": "EUR",
        "currencyTo": "LTC"
      },
      "reference": "string {'customer_mail': 'customer@example.com'}",
      "refundLink": "https://pay.confirmo.com/public/permit-refund/aW52MDJleTI0MWdrNGE5MmFjNGRkYTE1YjQ5ZDI3MzA4NzBhYWEzYjc5YzE=?refundEmail=test@bitcoin.com&merchantId=dfjeivkdienmv",
      "refunds": [
        {
          "address": "3Bp6GX52uY574Uq7k6opCx1zHd5hVhAXHq",
          "createdAt": 1594376981,
          "id": "refz0gr3qgx9",
          "notifyEmail": "test@test.com",
          "refundedAt": 1594376981,
          "substatus": "SCREENING_IN_PROGRESS",
          "txid": "4f13bc54e8df1620f98934078caaa59c7b480f3ed64e9838f5af519f311bb0b1",
          "updatedAt": 1594376981
        }
      ],
      "requiredConfirmations": 2,
      "requiredConfirmationsToRefund": 6,
      "resolvedByEmail": "user@mail.ex",
      "resolvedManually": true,
      "returnUrl": "https://yourEShop.com/orderReceived",
      "settlement": {
        "createdAt": 1561363200,
        "currency": "EUR",
        "id": "setv9e1qxgz8"
      },
      "settlementAmount": {
        "amount": 1000,
        "currency": "EUR"
      },
      "takeInfo": {
        "customerCurrency": "LTC",
        "expiration": 1552987955,
        "expirationDuration": 120,
        "offeredSettlementAmount": 3198,
        "settlementCurrency": "EUR",
        "taken": true,
        "takenAt": 1552987719
      },
      "timeoutTime": 1506080071,
      "unhandledExceptions": true,
      "url": "https://pay.confirmo.com/public/invoice/NOLvQIt2na6kfXBb?m=dfjeivkdienmv",
      "version": 42
    }
  ],
  "limit": 20,
  "order": "createdAt, desc",
  "totalCount": 150
}

Changes

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