Worldpay.CardPayouts (Worldpay v1.0.0)

Copy Markdown View Source

Worldpay Card Payouts API — push funds to Visa / Mastercard cards.

Supports basic disbursements and Fast Access (≤30 min delivery).

Summary

Functions

Basic card disbursement.

Fast Access payout — funds arrive on eligible cards within 30 minutes.

Search card payouts. Maximum 31-day date range.

Functions

disburse(body, config, opts \\ [])

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

Basic card disbursement.

fast_access(body, config, opts \\ [])

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

Fast Access payout — funds arrive on eligible cards within 30 minutes.

Pass fallback_to_basic: true to automatically fall back to basic disbursement when Fast Access is unavailable.

search(params \\ [], config)

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

Search card payouts. Maximum 31-day date range.

Query options

  • :start_date — ISO 8601 date
  • :end_date — ISO 8601 date
  • :transaction_reference