List Crypto Invoices

This endpoint lists crypto invoices (gateway payments) with advanced filtering support.

GET /invoices/payment-gateway

List Crypto Invoices

cURL

curl --request GET \
  --url https://api.gates2b.com/invoices/payment-gateway \
  --header 'Authorization: <authorization>'

{
  "status": 200,
  "code": "success",
  "response": {
    "data": [
      {
        "id": "68d2fa97b30181b2d2f13600",
        "type": "PAYMENT",
        "status": "WAITING_PAYMENT",
        "amount": 71.4226873,
        "currency": "BRL",
        "gateway": "NOWPAYMENTS",
        "user_id": 123,
        "external_reference": "INV-2024-001",
        "createdAt": "2024-09-24T19:52:55.998Z",
        "updatedAt": "2024-09-24T19:52:55.998Z",
        "payment_details": {
          "pay_address": "0x1CEfB8730786f34af8B10dC4e5B8028F79a63abd",
          "qr_code": "iVBORw0KGgoAAAANSUhEUgAAAJQAAACUCAYAAAB1PADUAAAAAklEQVR4AewaftIAAATVSURBVO3BQY4jRxAEwfAC//9l1x7zVECjk7MjKczwj1QtOaladFK16KRq0UnVopOqRSdVi06qFp1ULTqpWnRSteikatFJ1aKTqkUnVYtOqhZ98hKQn6Tmm4BMaiYgT6h5A8hPUvPGSdWik6pFJ1WLPlmmZhOQJ4DcqJmATGomIDdqboBMat5QswnIppOqRSdVi06qFn3yZUCeUPMEkEnNBGQCMqmZgGxScwNkUvMEkCfUfNNJ1aKTqkUnVYs++Z9RMwGZ1DwBZFIzAblR819yUrXopGrRSdWiT/5ngNwAmdRMQJ5QcwNkUvNvdlK16KRq0UnVok++TM1PAjKpeQPIjZobIJOaSc0ban6Tk6pFJ1WLTqoWfbIMyN+kZgIyqZmATGpu1ExAJjVPAJnU3AD5zU6qFp1ULTqpWvTJS2p+MzVPAJnUPAFkk5p/k5OqRSdVi06qFuEfeQHIpGYCsknNDZAbNU8AmdS8AWRScwNkk5pvOqladFK16KRq0ScvqdmkZpOaGyBPAHlDzQ2QSc0NkEnNDZBJzaaTqkUnVYtOqhZ98hKQbwKyCcik5g0gk5obIJOaSc0NkBsgN2q+6aRq0UnVopOqRZ+8pGYCcqPmCTVPAPkmIG+oeQLIpOYGyKTmJ51ULTqpWnRSteiTL1NzA+QJNTdqJiCTmgnIpGYCMql5AsikZgJyo2YCcqPmBsikZtNJ1aKTqkUnVYvwj7wA5EbNBGRSMwGZ1ExAbtTcAJnUTECeUDMBmdT8JCCTmhsgk5o3TqoWnVQtOqla9MmXAZnUPAFkUjMBmYDcqJmATGqeADKpmYBMam6APKHmCSCTmk0nVYtOqhadVC36ZJmaCcgNkEnNDZBJzQ2QGzUTkEnNBGRSc6NmAnKj5gkgv8lJ1aKTqkUnVYs++TI1E5BJzQTkRs0mIJOaJ4BMap5QMwF5Q80E5AbIpOaNk6pFJ1WLTqoWfbIMyBtqNql5AsgTaiYgN2qeUHMDZAIyqbkBsumkatFJ1aKTqkX4R14AMqm5AfKGmhsgk5pNQCY1TwC5UTMBeULNBGRS800nVYtOqhadVC365MuATGpugExqJiCTmknNBGRSMwGZ1ExAJjUTkEnNjZobIJOaJ4BMaiYgk5pNJ1WLTqoWnVQt+uTL1ExAngAyqZmAPAHkCTU3ap4A8gSQJ9T8TSdVi06qFp1ULfrkJTVPqPlN1DwBZFKzSc0TQJ5QMwGZ1LxxUrXopGrRSdWiT14C8pPUTGpugExq3lDzBJBJzQTkBsik5gkgN2o2nVQtOqladFK16JNlajYBuQEyqZnUTEBu1NwAeQPIE2reUHMDZFLzxknVopOqRSdViz75MiBPqNkEZJOaJ4BMaiYgE5A3gExqbtRsOqladFK16KRq0Sf/MUAmNU8AmdRMQCY1E5An1NwAmdS8AWRSs+mkatFJ1aKTqkWf/McB+ZvU3AC5UTMBuVHzN51ULTqpWnRSteiTL1PzTWpugNyouQFyA2RSMwG5UXMD5EbNb3JSteikatFJ1aJPlgH5SUBu1ExAJiCTmknNJjVPqJmA3ACZ1ExqvumkatFJ1aKTqkX4R6qWnFQtOqladFK16KRq0UnVopOqRSdVi06qFp1ULTqpWnRSteikatFJ1aKTqkUnVYv+AeMiPTU2TMAbAAAAAElFTkSuQmCC",
          "expires_at": "2024-09-24T20:52:55.998Z",
          "pay_currency": "USDTBSC",
          "fiat_currency": "BRL"
        }
      }
    ],
    "pagination": {
      "page": 1,
      "quantityPerPage": 10,
      "total": 1,
      "totalPages": 1
    }
  }
}

Authorization · string · required

The Bearer authentication token is required to access this endpoint.

page · number

Page number (default: 1). Minimum value: 1.

quantityPerPage · number

Items per page (default: 10). Minimum value: 1.

orderBy · string

Sort by field.direction (e.g., createdAt.DESC, amount.ASC).

type · string

Filter by invoice type (PAYMENT or WITHDRAWAL). Automatically converted to uppercase.

status · string

Filter by invoice status.

gateway · string

Filter by gateway name.

start_date · string

Start date for period filter (ISO string format).

end_date · string

End date for period filter (ISO string format).

user_id · number

Filter by user ID (admin/operator only).

query · string

General text search.

Response

status · number

HTTP response code. Expected: 200 (OK).

code · string

Response status code.

response · object

Response content.

Show Show object

data · array

List of returned invoices.

Show Show array

id · string

Unique invoice identifier.

type · string

Invoice type (PAYMENT or WITHDRAWAL).

status · string

Current invoice status.

amount · number

Transaction amount.

currency · string

Transaction currency.

gateway · string

Gateway name used.

user_id · number

Invoice owner user ID.

external_reference · string

External reference for your application.

createdAt · string

Invoice creation date.

updatedAt · string

Invoice last update date.

payment_details · object

Payment-specific details.

Show Show object

pay_address · string

Address to send funds to.

qr_code · string

Base64 QR code for payment.

expires_at · string

Payment expiration date.

pay_currency · string

Crypto currency used for payment.

fiat_currency · string

Fiat reference currency.

pagination · object

Pagination information.

Show Show object

page · number

Current page.

quantityPerPage · number

Items per page.

total · number

Total records found.

totalPages · number

Total pages available.

{
  "status": 200,
  "code": "success",
  "response": {
    "data": [
      {
        "id": "68d2fa97b30181b2d2f13600",
        "type": "PAYMENT",
        "status": "WAITING_PAYMENT",
        "amount": 71.4226873,
        "currency": "BRL",
        "gateway": "NOWPAYMENTS",
        "user_id": 123,
        "external_reference": "INV-2024-001",
        "createdAt": "2024-09-24T19:52:55.998Z",
        "updatedAt": "2024-09-24T19:52:55.998Z",
        "payment_details": {
          "pay_address": "0x1CEfB8730786f34af8B10dC4e5B8028F79a63abd",
          "qr_code": "iVBORw0KGgoAAAANSUhEUgAAAJQAAACUCAYAAAB1PADUAAAAAklEQVR4AewaftIAAATVSURBVO3BQY4jRxAEwfAC//9l1x7zVECjk7MjKczwj1QtOaladFK16KRq0UnVopOqRSdVi06qFp1ULTqpWnRSteikatFJ1aKTqkUnVYtOqhZ98hKQn6Tmm4BMaiYgT6h5A8hPUvPGSdWik6pFJ1WLPlmmZhOQJ4DcqJmATGomIDdqboBMat5QswnIppOqRSdVi06qFn3yZUCeUPMEkEnNBGQCMqmZgGxScwNkUvMEkCfUfNNJ1aKTqkUnVYs++Z9RMwGZ1DwBZFIzAblR819yUrXopGrRSdWiT/5ngNwAmdRMQJ5QcwNkUvNvdlK16KRq0UnVok++TM1PAjKpeQPIjZobIJOaSc0ban6Tk6pFJ1WLTqoWfbIMyN+kZgIyqZmATGpu1ExAJjVPAJnU3AD5zU6qFp1ULTqpWvTJS2p+MzVPAJnUPAFkk5p/k5OqRSdVi06qFuEfeQHIpGYCsknNDZAbNU8AmdS8AWRScwNkk5pvOqladFK16KRq0ScvqdmkZpOaGyBPAHlDzQ2QSc0NkEnNDZBJzaaTqkUnVYtOqhZ98hKQbwKyCcik5g0gk5obIJOaSc0NkBsgN2q+6aRq0UnVopOqRZ+8pGYCcqPmCTVPAPkmIG+oeQLIpOYGyKTmJ51ULTqpWnRSteiTL1NzA+QJNTdqJiCTmgnIpGYCMql5AsikZgJyo2YCcqPmBsikZtNJ1aKTqkUnVYvwj7wA5EbNBGRSMwGZ1ExAbtTcAJnUTECeUDMBmdT8JCCTmhsgk5o3TqoWnVQtOqla9MmXAZnUPAFkUjMBmYDcqJmATGqeADKpmYBMam6APKHmCSCTmk0nVYtOqhadVC36ZJmaCcgNkEnNDZBJzQ2QGzUTkEnNBGRSc6NmAnKj5gkgv8lJ1aKTqkUnVYs++TI1E5BJzQTkRs0mIJOaJ4BMap5QMwF5Q80E5AbIpOaNk6pFJ1WLTqoWfbIMyBtqNql5AsgTaiYgN2qeUHMDZAIyqbkBsumkatFJ1aKTqkX4R14AMqm5AfKGmhsgk5pNQCY1TwC5UTMBeULNBGRS800nVYtOqhadVC365MuATGpugExqJiCTmknNBGRSMwGZ1ExAJjUTkEnNjZobIJOaJ4BMaiYgk5pNJ1WLTqoWnVQt+uTL1ExAngAyqZmAPAHkCTU3ap4A8gSQJ9T8TSdVi06qFp1ULfrkJTVPqPlN1DwBZFKzSc0TQJ5QMwGZ1LxxUrXopGrRSdWiT14C8pPUTGpugExq3lDzBJBJzQTkBsik5gkgN2o2nVQtOqladFK16JNlajYBuQEyqZnUTEBu1NwAeQPIE2reUHMDZFLzxknVopOqRSdViz75MiBPqNkEZJOaJ4BMaiYgE5A3gExqbtRsOqladFK16KRq0Sf/MUAmNU8AmdRMQCY1E5An1NwAmdS8AWRSs+mkatFJ1aKTqkWf/McB+ZvU3AC5UTMBuVHzN51ULTqpWnRSteiTL1PzTWpugNyouQFyA2RSMwG5UXMD5EbNb3JSteikatFJ1aJPlgH5SUBu1ExAJiCTmknNJjVPqJmA3ACZ1ExqvumkatFJ1aKTqkX4R6qWnFQtOqladFK16KRq0UnVopOqRSdVi06qFp1ULTqpWnRSteikatFJ1aKTqkUnVYv+AeMiPTU2TMAbAAAAAElFTkSuQmCC",
          "expires_at": "2024-09-24T20:52:55.998Z",
          "pay_currency": "USDTBSC",
          "fiat_currency": "BRL"
        }
      }
    ],
    "pagination": {
      "page": 1,
      "quantityPerPage": 10,
      "total": 1,
      "totalPages": 1
    }
  }
}