Payout (credit) operations for the Paysafe Payments API.
Payouts push money to a customer's card or account. Two payout types are
supported, each its own flat resource (no account ID in the URL —
accountId is an optional field in the request body, used only when your
API key has multiple accounts configured for the same payment method):
/paymenthub/v1/standalonecredits— General payouts (non-iGaming)./paymenthub/v1/originalcredits— iGaming sector payouts.
Note: 3DS does not apply to payouts. Use transactionType: STANDALONE_CREDIT
or ORIGINAL_CREDIT in your payment handle.
Summary
Functions
Cancel a standalone credit.
Get an original credit by ID.
Get a standalone credit by ID.
Create an original credit (payout for iGaming merchants).
Create a standalone credit (payout for non-iGaming merchants).
Functions
@spec cancel_standalone_credit(Paysafe.Config.t(), String.t(), keyword()) :: {:ok, map()} | {:error, Paysafe.Error.t()}
Cancel a standalone credit.
@spec get_original_credit(Paysafe.Config.t(), String.t(), keyword()) :: {:ok, map()} | {:error, Paysafe.Error.t()}
Get an original credit by ID.
@spec get_standalone_credit(Paysafe.Config.t(), String.t(), keyword()) :: {:ok, map()} | {:error, Paysafe.Error.t()}
Get a standalone credit by ID.
@spec original_credit(Paysafe.Config.t(), map(), keyword()) :: {:ok, map()} | {:error, Paysafe.Error.t()}
Create an original credit (payout for iGaming merchants).
Parameters
:merchant_ref_num(required) — Unique reference.:amount(required) — Amount in minor units.:currency_code(required) — ISO 4217 currency code.:payment_handle_token(required) — Token from anORIGINAL_CREDIThandle.:account_id— Only needed if your API key has multiple accounts configured for the same payment method/currency combination.
@spec standalone_credit(Paysafe.Config.t(), map(), keyword()) :: {:ok, map()} | {:error, Paysafe.Error.t()}
Create a standalone credit (payout for non-iGaming merchants).
Parameters
:merchant_ref_num(required) — Unique reference.:amount(required) — Amount in minor units.:currency_code(required) — ISO 4217 currency code.:payment_handle_token(required) — Token from aSTANDALONE_CREDIThandle.:account_id— Only needed if your API key has multiple accounts configured for the same payment method/currency combination.