Creates an Refund object
- Parameters:
params - a dict of parameters; valid keys are:
-
amount : Amount of the refund in the smallest
unit of your currency. Example: 100 = $1.00USD [min value: 1,
max value: 9999900] required
-
payment : ID of the payment for the refund
required
-
reason : Reason for the refund
-
reference : Custom reference field to be used
with outside systems.
-
replayId : An identifier that can be sent to
uniquely identify a refund request to facilitate retries due
to I/O related issues. This identifier must be unique for
your account (sandbox or live) across all of your refunds. If
supplied, we will check for a refund on your account that
matches this identifier. If found we will return an identical
response to that of the original request. [max length: 50,
min length: 1]
auth_args - an Authentication object used for the API call. If no value is
passed the gloabl keys simplify.public_key and
simplify.private_key are used. For backwards compatibility the
public and private keys may be passed instead of an
Authentication object.
private_api_key - Private key to use for the API call. If None , the
value of simplify.private_key will be used.
- Returns:
- a Refund object
|