Worldpay.Reporting.BatchTransactions (Worldpay v1.0.0)

Copy Markdown View Source

Worldpay Batch Transaction API (Access).

Submit batch details and retrieve authorized batch summaries. Used alongside Worldpay.Statements for full settlement reconciliation.

This is distinct from cnpAPI batch files (which use SFTP) — this API accepts batch metadata via REST and returns settlement summaries.

Summary

Functions

get(batch_id, config)

Retrieve batch details by batch ID.

list(params \\ [], config)

List all batches, optionally filtered by date range.

submit(body, config)

Submit a batch for processing.

Functions

get(batch_id, config)

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

Retrieve batch details by batch ID.

list(params \\ [], config)

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

List all batches, optionally filtered by date range.

submit(body, config)

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

Submit a batch for processing.