Facades: merchant
Overview
Creates a new refund request.
Parameters
| Parameter | Description |
|---|---|
| invoice_id * | The BitPay invoice Id having the associated refund to be created |
| amount * | Amount to be refunded in the currency indicated |
| preview | Whether to create the refund request as a preview, which will not be acted on until status is updated (default: false) |
| immediate | Whether funds should be removed from merchant ledger immediately on submission or at time of processing (default: false) |
| buyer_pays_refund_fee | Whether the buyer should pay the refund fee (default: merchant) |
| reference | Present only if specified in the request to create the refund |
| guid | Variable provided by the merchant and designed to be used by the merchant to correlate the refund with a refund ID in their system. |
Example
Note
In this example, we assume that a Client has already been initialized and assigned to the
bitpayvariable.
bitpay.create_refund('invoiceId', 12.34)