com.simplify.payments.domain

Class Refund

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,java.lang.Object>

com.simplify.payments.PaymentsMap

com.simplify.payments.PaymentsObject

com.simplify.payments.domain.Refund

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class Refund
extends PaymentsObject

A Refund object.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields inherited from class com.simplify.payments.PaymentsObject

authentication

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Refund()
protected	Refund(java.util.Map m)
protected	Refund(PaymentsObject o)

Method Summary

Modifier and Type	Method and Description
static Refund	create(Authentication auth, java.util.Map map) Creates an Refund object
static Refund	create(java.util.Map map) Creates an Refund object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static Refund	create(java.lang.String publicKey, java.lang.String privateKey, java.util.Map map) Deprecated. As of release 1.1, replaced by create(Authentication, Map)
static Refund	find(Authentication auth, java.lang.String id) Retrieve a Refund object.
static Refund	find(java.lang.String id) Retrieve a Refund object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static Refund	find(java.lang.String publicKey, java.lang.String privateKey, java.lang.String id) Deprecated. As of release 1.1, replaced by find(Authentication, String)
protected java.lang.String	getObjectType()
static ResourceList<Refund>	list() Retrieve Refund objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<Refund>	list(Authentication auth) Retrieve Refund objects using the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<Refund>	list(Authentication auth, java.util.Map criteria) Retrieve Refund objects using the specified criteria.
static ResourceList<Refund>	list(java.util.Map criteria) Retrieve Refund objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static ResourceList<Refund>	list(java.lang.String publicKey, java.lang.String privateKey) Deprecated. As of release 1.1, replaced by list(Authentication)
static ResourceList<Refund>	list(java.lang.String publicKey, java.lang.String privateKey, java.util.Map criteria) Deprecated. As of release 1.1, replaced by list(Authentication, Map)

Methods inherited from class com.simplify.payments.PaymentsObject

createObject, deleteObject, findObject, getAuthentication, listObjects, listObjects, updateObject

Methods inherited from class com.simplify.payments.PaymentsMap

containsKey, get, normalize, put, remove, set

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Constructor Detail

Refund

protected Refund()

Refund

protected Refund(PaymentsObject o)

Refund

protected Refund(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

public static Refund create(java.util.Map map)
                     throws ApiCommunicationException,
                            AuthenticationException,
                            InvalidRequestException,
                            NotAllowedException,
                            SystemException

Creates an Refund object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

map - a map of parameters, valid keys and types:

java.lang.Long amount

Amount of the refund in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.String payment

ID of the payment for the refund

java.lang.String reason

Reason for the refund

java.lang.String reference

Custom reference field to be used with outside systems.

java.lang.String 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]

payments.command.api.APIDescriptorCommand statementDescription

A custom descriptor for the transaction to appear on the customer's bank statement.

java.lang.String statementDescription.name

Merchant name. required

java.lang.String statementDescription.phoneNumber

Merchant contact phone number.

Returns:

a Refund object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static Refund create(java.lang.String publicKey,
                                        java.lang.String privateKey,
                                        java.util.Map map)
                                 throws ApiCommunicationException,
                                        AuthenticationException,
                                        InvalidRequestException,
                                        NotAllowedException,
                                        SystemException

Deprecated. As of release 1.1, replaced by create(Authentication, Map)

Creates an Refund object

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.Long amount

Amount of the refund in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.String payment

ID of the payment for the refund

java.lang.String reason

Reason for the refund

java.lang.String reference

Custom reference field to be used with outside systems.

java.lang.String 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]

payments.command.api.APIDescriptorCommand statementDescription

A custom descriptor for the transaction to appear on the customer's bank statement.

java.lang.String statementDescription.name

Merchant name. required

java.lang.String statementDescription.phoneNumber

Merchant contact phone number.

Returns:

a Refund object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

public static Refund create(Authentication auth,
                            java.util.Map map)
                     throws ApiCommunicationException,
                            AuthenticationException,
                            InvalidRequestException,
                            NotAllowedException,
                            SystemException

Creates an Refund object

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.Long amount

Amount of the refund in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.String payment

ID of the payment for the refund

java.lang.String reason

Reason for the refund

java.lang.String reference

Custom reference field to be used with outside systems.

java.lang.String 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]

payments.command.api.APIDescriptorCommand statementDescription

A custom descriptor for the transaction to appear on the customer's bank statement.

java.lang.String statementDescription.name

Merchant name. required

java.lang.String statementDescription.phoneNumber

Merchant contact phone number.

Returns:

a Refund object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

list

public static ResourceList<Refund> list()
                                 throws ApiCommunicationException,
                                        AuthenticationException,
                                        InvalidRequestException,
                                        NotAllowedException,
                                        SystemException

Retrieve Refund objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).

Returns:

a ResourceList object which holds the list of Refund objects and the total number of Refund objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

@Deprecated
public static ResourceList<Refund> list(java.lang.String publicKey,
                                                    java.lang.String privateKey)
                                             throws ApiCommunicationException,
                                                    AuthenticationException,
                                                    InvalidRequestException,
                                                    NotAllowedException,
                                                    SystemException

Deprecated. As of release 1.1, replaced by list(Authentication)

Retrieve Refund objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of Refund objects and the total number of Refund objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Refund> list(Authentication auth)
                                 throws ApiCommunicationException,
                                        AuthenticationException,
                                        InvalidRequestException,
                                        NotAllowedException,
                                        SystemException

Retrieve Refund objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

Returns:

a ResourceList object which holds the list of Refund objects and the total number of Refund objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Refund> list(java.util.Map criteria)
                                 throws ApiCommunicationException,
                                        AuthenticationException,
                                        InvalidRequestException,
                                        NotAllowedException,
                                        SystemException

Retrieve Refund objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the refund Id
filter.text	Filter by the refund description text
filter.replayId	Filter by the compoundReplayId
filter.authCode	Filter by the authorization code (Not authorization ID)
filter.amount	Filter by the refund amount (in the smallest unit of your currency)
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis
filter.deposit	Filter by the deposit id
filter.q	You can use this to filter by the Id, the authCode or the amount of the refund

^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map 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:

a ResourceList object which holds the list of Refund objects and the total number of Refund objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Refund> list(java.lang.String publicKey,
                                        java.lang.String privateKey,
                                        java.util.Map criteria)
                                 throws ApiCommunicationException,
                                        AuthenticationException,
                                        InvalidRequestException,
                                        NotAllowedException,
                                        SystemException

Deprecated. As of release 1.1, replaced by list(Authentication, Map)

Retrieve Refund objects using the specified criteria.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the refund Id
filter.text	Filter by the refund description text
filter.replayId	Filter by the compoundReplayId
filter.authCode	Filter by the authorization code (Not authorization ID)
filter.amount	Filter by the refund amount (in the smallest unit of your currency)
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis
filter.deposit	Filter by the deposit id
filter.q	You can use this to filter by the Id, the authCode or the amount of the refund

^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map 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 .

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of Refund objects and the total number of Refund objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Refund> list(Authentication auth,
                                        java.util.Map criteria)
                                 throws ApiCommunicationException,
                                        AuthenticationException,
                                        InvalidRequestException,
                                        NotAllowedException,
                                        SystemException

Retrieve Refund objects using the specified criteria.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the refund Id
filter.text	Filter by the refund description text
filter.replayId	Filter by the compoundReplayId
filter.authCode	Filter by the authorization code (Not authorization ID)
filter.amount	Filter by the refund amount (in the smallest unit of your currency)
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis
filter.deposit	Filter by the deposit id
filter.q	You can use this to filter by the Id, the authCode or the amount of the refund

^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map 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:

a ResourceList object which holds the list of Refund objects and the total number of Refund objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

public static Refund find(java.lang.String id)
                   throws ApiCommunicationException,
                          AuthenticationException,
                          InvalidRequestException,
                          ObjectNotFoundException,
                          NotAllowedException,
                          SystemException

Retrieve a Refund object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

id - the id of the Refund object to retrieve

Returns:

a Refund object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static Refund find(java.lang.String publicKey,
                                      java.lang.String privateKey,
                                      java.lang.String id)
                               throws ApiCommunicationException,
                                      AuthenticationException,
                                      InvalidRequestException,
                                      ObjectNotFoundException,
                                      NotAllowedException,
                                      SystemException

Deprecated. As of release 1.1, replaced by find(Authentication, String)

Retrieve a Refund object.

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

id - the id of the Refund object to retrieve

Returns:

a Refund object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

public static Refund find(Authentication auth,
                          java.lang.String id)
                   throws ApiCommunicationException,
                          AuthenticationException,
                          InvalidRequestException,
                          ObjectNotFoundException,
                          NotAllowedException,
                          SystemException

Retrieve a Refund object.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

id - the id of the Refund object to retrieve

Returns:

a Refund object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException