Worldpay.Client (Worldpay v1.0.0)

Copy Markdown View Source

Low-level HTTP client for all Worldpay REST APIs.

Wraps Req with:

  • Basic Auth injection
  • WP-Api-Version header management
  • WP-CorrelationId per-request tracing header
  • JSON encode/decode
  • Telemetry spans on every call
  • Auto-generated idempotency keys on mutations
  • Optional circuit breaker via :fuse
  • XML client for WPG (wpg_post/2)

Summary

Functions

GET request against the Access API.

POST request against the Access API.

POST XML to the WPG endpoint.

Types

header()

@type header() :: {String.t(), String.t()}

headers()

@type headers() :: [header()]

result()

@type result() :: {:ok, map() | nil} | {:error, Worldpay.Error.t()}

xml_result()

@type xml_result() :: {:ok, String.t()} | {:error, Worldpay.Error.t()}

Functions

delete(path, opts \\ [], config)

@spec delete(String.t(), keyword(), Worldpay.Config.t()) :: result()

DELETE request.

get(path, opts \\ [], config)

@spec get(String.t(), keyword(), Worldpay.Config.t()) :: result()

GET request against the Access API.

patch(path, body, opts \\ [], config)

@spec patch(String.t(), map(), keyword(), Worldpay.Config.t()) :: result()

PATCH request.

post(path, body, opts \\ [], config)

@spec post(String.t(), map(), keyword(), Worldpay.Config.t()) :: result()

POST request against the Access API.

put(path, body, opts \\ [], config)

@spec put(String.t(), map(), keyword(), Worldpay.Config.t()) :: result()

PUT request.

wpg_post(xml_body, config)

@spec wpg_post(String.t(), Worldpay.Config.t()) :: xml_result()

POST XML to the WPG endpoint.