API Documentation
\

\Simplify_Refund

Base class for all domain objects.

Summary

Methods
Properties
Constants
createRefund()
listRefund()
findRefund()
setAll()
getProperties()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$properties
N/A

Properties

$properties

$properties

Methods

createRefund()

createRefund(array $hash, mixed $authentication) : \Refund

Creates an Simplify_Refund object

Parameters

array $hash

a map 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.
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.<i/>

Returns

\Refund —

a Refund object.

listRefund()

listRefund( $criteria, mixed $authentication) : \ResourceList

Retrieve Simplify_Refund objects.

Parameters

$criteria
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\ResourceList —

a ResourceList object that holds the list of Refund objects and the total number of Refund objects available for the given criteria.

findRefund()

findRefund( $id, mixed $authentication) : \Refund

Retrieve a Simplify_Refund object from the API

Parameters

$id
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\Refund —

a Refund object

setAll()

setAll(mixed $hash)

Updates the object's properties with the values in the specified map.

Parameters

mixed $hash

array Map of values to set.

getProperties()

getProperties() : array

Returns the object's properties as a map.

Returns

array —

map of properties.