Skip to main content

Documentation

Creating a Refund
Create Refund - Request Parameters

The parameters for a 'Create Refund' request vary depending on the type of payment and type of refund.

For code examples, see Create Refund.

Refunds for a Payment to a Single Wallet

The following table shows the parameters for refunds of a payment to a single wallet.

Refund Description

Parameters

A full refund.

  • payment - The ID of the payment.

A partial refund.

  • payment - The ID of the payment.

  • amount - The amount of the refund.

A refund of the payment balance following partial refunds.

  • payment - The ID of the payment.

Refunds for a Split Payment

The following table shows the parameters for refunds of a payment split among multiple wallets, the result of the refund request, and whether a payment balance remains.

Refund Description

Parameters

Result

Balance

A full refund from all wallets.

  • payment - The ID of the payment.

Each wallet is charged the full amount it received in the payment.

No

A proportional partial refund from all wallets.

  • payment - The ID of the payment.amount - The amount of the refund.

The refund is divided among all wallets according to the proportion of the payment that each received.

Yes

A refund of the payment balance following proportional partial refunds from all wallets.

  • payment - The ID of the payment.

The refund is divided among all wallets according to the proportion of the payment that each received.

No

A full refund from at least one, but not all, of the wallets.

  • payment - The Payment object ID.

  • ewallets - For each wallet charged a refund:

    • ewallet - The wallet ID.

    • amount or percent - The amount or percentage of the refund.

Each specified wallet is charged the specified amount.

  • Specified wallets: No

  • Other wallets: Yes

A non-proportional partial refund from one or more wallets.

  • payment - The Payment object ID.

  • ewallets - For each wallet charged a refund:

    • ewallet - The wallet ID.

    • amount or percent - The amount or percentage of the refund.

Each specified wallet is charged the specified amount.

Yes

A refund of the payment balance following:

  • Full refunds from some wallets.

  • Non-proportional partial refunds.

  • payment - The Payment object ID.

  • ewallets - For each wallet charged a refund:

    • ewallet - The wallet ID.

    • amount or percent - The amount or percentage of the refund.

Each specified wallet is charged the specified amount.

No

Note

Multiple refunds must be either all proportional or all non-proportional.