Get Payments Received

HTTP Method: GET
URL Path: https://public.zeroxpay.com/v1/store/payments
Query Parameters:

• startDate (optional): The start date for filtering payments received by the store (inclusive).
• endDate (optional): The end date for filtering payments received by the store (inclusive).
• fromAddress (optional): Filter payments by the sender's address.
• toAddress (optional): Filter payments by the recipient's address.

Description: Retrieves a list of payments received by the store within the specified date range, optionally filtered by sender and recipient addresses.

Response Structure

The response is a JSON array of objects, each representing a payment with the following fields:

• chain_id (number | null): The blockchain chain ID of the transaction. This field is null if not applicable.
• created_at (string): The creation date and time of the payment record in TIMESTAMPTZ format.
• currency_address (string | null): The address of the currency used for the payment. This field is null if not applicable.
• exchange_rate_to_usd (string | null): The exchange rate to USD at the time of the transaction. This field is null if not applicable.
• fee_amount (string | null): The transaction fee amount. This field is null if not applicable.
• from_address (string): The blockchain address of the sender.
• id (string): The unique identifier for the payment.
• metadata (Json | null): Additional metadata associated with the payment. This field is null if not applicable.
• product_id (string | null): The identifier of the product associated with the payment. This field is null if not applicable.
• sent_amount (string | null): The amount sent by the payer. This field is null if not applicable.
• store_id (string | null): The identifier of the store receiving the payment. This field is null if not applicable.
• to_address (string): The blockchain address of the recipient.
• total_amount (string): The total amount of the payment.
• tx_hash (string): The transaction hash of the payment.

Response Example

[
  {
    "chain_id": 1,
    "created_at": "2023-01-01 16:48:32.007852+00",
    "currency_address": "0x...",
    "exchange_rate_to_usd": "100",
    "fee_amount": "1",
    "from_address": "0x...",
    "id": "payment123",
    "metadata": null,
    "product_id": "prod456",
    "sent_amount": "100",
    "store_id": "store789",
    "to_address": "0x...",
    "total_amount": "99",
    "tx_hash": "0x..."
  }
]