Class Refund

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.00 required
  • payment: ID of the payment for the refund
  • 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]
  • statementDescription => name: Merchant name. required
  • statementDescription => phoneNumber: Merchant contact phone number.
• 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

Retrieve Refund objects.

Parameters:

• criteria - a dict of parameters; valid keys are:
  • filter <table class="filter_list"><tr><td>filter.id</td><td>Filter by the refund Id</td></tr><tr><td>filter.text</td><td>Filter by the refund description text</td></tr><tr><td>filter.replayId</td><td>Filter by the compoundReplayId</td></tr><tr><td>filter.authCode</td><td>Filter by the authorization code (Not authorization ID)</td></tr><tr><td>filter.amount</td><td>Filter by the refund amount (in the smallest unit of your currency)</td></tr><tr><td>filter.dateCreatedMin^*</td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax^*</td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.deposit</td><td>Filter by the deposit id</td></tr><tr><td>filter.q</td><td>You can use this to filter by the Id, the authCode or the amount of the refund</td></tr></table><br>^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates
  • max Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
  • offset Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]
  • sorting Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: id amount description dateCreated paymentDate.
• 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.

Returns:

an object which contains the list of Refund objects in the <code>list</code> property and the total number of objects available for the given criteria in the <code>total</code> property.

Retrieve a Refund object from the API

Parameters:

• object_id - ID of object to retrieve
• 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.

Returns:

a Refund object