Settlement operations for the Paysafe Payments API.
Settlements capture (settle) an authorized payment. If settle_with_auth
was false on the payment, you must call this endpoint to capture funds.
Partial settlement is supported — you can settle less than the authorized amount. You can also cancel a pending settlement.
Base path: /paymenthub/v1/payments/{paymentId}/settlements (no account
ID anywhere in the URL — settlements are addressed via the payment ID).
Summary
Functions
Cancel a pending settlement.
Create a settlement for an authorized payment.
Retrieve a settlement by ID.
Functions
@spec cancel(Paysafe.Config.t(), String.t(), keyword()) :: {:ok, Paysafe.Types.Settlement.t()} | {:error, Paysafe.Error.t()}
Cancel a pending settlement.
@spec create(Paysafe.Config.t(), String.t(), map(), keyword()) :: {:ok, Paysafe.Types.Settlement.t()} | {:error, Paysafe.Error.t()}
Create a settlement for an authorized payment.
Parameters
:merchant_ref_num(required) — Unique reference.:amount— Amount to settle (defaults to full authorized amount).:payment_id(required) — ID of the authorized payment.
@spec get(Paysafe.Config.t(), String.t(), keyword()) :: {:ok, Paysafe.Types.Settlement.t()} | {:error, Paysafe.Error.t()}
Retrieve a settlement by ID.