Simplify::Refund

Authentication object used to access the API (See Simplify::Authentication for details)

Creates an Refund object

• 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.

Returns a Refund object.

# File lib/simplify/refund.rb, line 72
def self.create(parms, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("refund", 'create', parms, auth_obj)
    obj = Refund.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj
end

Retrieve a Refund object from the API

Returns a Refund object.

# File lib/simplify/refund.rb, line 107
def self.find(id, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("refund", 'show', {"id" => id}, auth_obj)
    obj = Refund.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj
end

Retrieve Refund objects.

• 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.

Returns an object where the list property contains the list of Refund objects and the total property contains the total number of Refund objects available for the given criteria.

# File lib/simplify/refund.rb, line 91
def self.list(criteria = nil, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("refund", 'list', criteria, auth_obj)
    obj = Refund.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj

end

Returns the private key used when accessing this object. Deprecated: please use ‘authentication’ instead.

# File lib/simplify/refund.rb, line 50
def private_key
    return self.authentication.private_key
end

Sets the private key used when accessing this object. Deprecated: please use ‘authentication’ instead.

# File lib/simplify/refund.rb, line 55
def private_key=(k)
    return self.authentication.private_key = k
end

Returns the public key used when accessing this object. Deprecated: please use ‘authentication’ instead.

# File lib/simplify/refund.rb, line 40
def public_key
    return self.authentication.public_key
end

Sets the public key used when accessing this object. Deprecated: please use ‘authentication’ instead.

# File lib/simplify/refund.rb, line 45
def public_key=(k)
    return self.authentication.public_key = k
end