Worldpay.PaymentQueries (Worldpay v1.0.0)

Copy Markdown View Source

Worldpay Payment Queries API — query payment history.

This is an aggregation service with up to 60 seconds of latency. Not suitable for real-time status checks immediately after payment.

Query modes

  • By date range (from 25 Jun 2024 onward; paginated)
  • By transactionReference
  • By paymentId (single payment, full detail)
  • Historical (pre-Jun 2024; minimal fields; requires entityReference)

Summary

Functions

by_date_range(start_date, end_date, config, opts \\ [])

Query payments by date range.

by_id(payment_id, config)

Retrieve a single payment by paymentId (full detail).

by_transaction_reference(ref, config, opts \\ [])

Query payments by transaction reference.

Functions

by_date_range(start_date, end_date, config, opts \\ [])

@spec by_date_range(String.t(), String.t(), Worldpay.Config.t(), keyword()) ::
  {:ok, map()} | {:error, Worldpay.Error.t()}

Query payments by date range.

by_id(payment_id, config)

@spec by_id(String.t(), Worldpay.Config.t()) ::
  {:ok, map()} | {:error, Worldpay.Error.t()}

Retrieve a single payment by paymentId (full detail).

by_transaction_reference(ref, config, opts \\ [])

@spec by_transaction_reference(String.t(), Worldpay.Config.t(), keyword()) ::
  {:ok, map()} | {:error, Worldpay.Error.t()}

Query payments by transaction reference.