com.simplify.payments.domain

Class Payment

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

All Implemented Interfaces:

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

public class Payment
extends PaymentsObject

A Payment 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	Payment()
protected	Payment(java.util.Map m)
protected	Payment(PaymentsObject o)

Method Summary

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

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

Payment

protected Payment()

Payment

protected Payment(PaymentsObject o)

Payment

protected Payment(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

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

Creates an Payment 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 payment (in the smallest unit of your currency). Example: 100 = $1.00

java.lang.String authorization

The ID of the authorization being used to capture the payment.

payments.command.api.APICardCommand card

Credit or debit card being used to apply the payment to.

java.lang.String card.addressCity

City of the cardholder. [max length: 50, min length: 2]

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]

java.lang.String card.addressLine1

Address of the cardholder. [max length: 255]

java.lang.String card.addressLine2

Address of the cardholder if needed. [max length: 255]

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. [max length: 255]

java.lang.String card.addressZip

Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 32]

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]

java.lang.String card.name

Name as it appears on the card. [max length: 50, min length: 2]

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String currency

Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] required

java.lang.String customer

ID of customer. If specified, card on file of customer will be used.

java.lang.String description

Free form text field to be used as a description of the payment. This field is echoed back with the payment on any find or list operations. [max length: 1024]

java.lang.String invoice

ID of invoice for which this payment is being made.

java.lang.String invoiceReference

Invoice reference number.

payments.command.api.APIOrderCreateCommand order

Detailed order information.

java.lang.String order.commodityCode

Standard classification code for products and services. [max length: 5]

java.lang.String order.customer

ID of the customer associated with the order.

java.lang.String order.customerEmail

Customer email address.

java.lang.String order.customerName

Customer name.

java.lang.String order.customerNote

Additional notes provided by the customer. [max length: 255]

java.lang.String order.customerReference

A merchant reference for the customer.

payments.command.api.APIOrderItemCreateCommand order.items

Detailed information about individual items contained in the order.

java.lang.Long order.items.amount

Cost of the item.

java.lang.String order.items.description

Description of the item.

java.lang.String order.items.name

Item name.

java.lang.String order.items.product

Product information associated with the item.

java.lang.Long order.items.quantity

Quantity of the item contained in the order [min value: 1, max value: 999999, default: 1] required

java.lang.String order.items.reference

A merchant reference for the item. [max length: 255]

java.lang.String order.items.tax

Taxes associated with the item.

java.lang.String order.merchantNote

Additional notes provided by the merchant. [max length: 255]

java.lang.String order.payment

ID of the payment associated with the order.

java.lang.String order.reference

A merchant reference for the order. [max length: 255]

payments.command.api.APIAddressCommand order.shippingAddress

Address the products are being shipped to.

java.lang.String order.shippingAddress.city

City, town, or municipality. [max length: 255, min length: 2]

java.lang.String order.shippingAddress.country

2-character country code. [max length: 2, min length: 2]

java.lang.String order.shippingAddress.line1

Street address. [max length: 255]

java.lang.String order.shippingAddress.line2

(Opt) Street address continued. [max length: 255]

java.lang.String order.shippingAddress.name

Name of the entity being shipped to. [max length: 255]

java.lang.String order.shippingAddress.state

State or province. [max length: 255]

java.lang.String order.shippingAddress.zip

Postal code. [max length: 32]

payments.command.api.APIAddressCommand order.shippingFromAddress

Address the products are being shipped from.

java.lang.String order.shippingFromAddress.city

City, town, or municipality. [max length: 255, min length: 2]

java.lang.String order.shippingFromAddress.country

2-character country code. [max length: 2, min length: 2]

java.lang.String order.shippingFromAddress.line1

Street address. [max length: 255]

java.lang.String order.shippingFromAddress.line2

(Opt) Street address continued. [max length: 255]

java.lang.String order.shippingFromAddress.name

Name of the entity performing the shipping. [max length: 255]

java.lang.String order.shippingFromAddress.state

State or province. [max length: 255]

java.lang.String order.shippingFromAddress.zip

Postal code. [max length: 32]

java.lang.String order.shippingName

Name of the entity being shipped to.

java.lang.String order.source

Order source. [default: WEB] required

java.lang.String order.status

Status of the order. [default: INCOMPLETE] required

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 payment 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 payments. If supplied, we will check for a payment on your account that matches this identifier. If found will attempt to return an identical response 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.

java.lang.Boolean taxExempt

Specify true to indicate that the payment is tax-exempt.

java.lang.String token

If specified, card associated with card token will be used. [max length: 255]

Returns:

a Payment object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static Payment 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 Payment 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 payment (in the smallest unit of your currency). Example: 100 = $1.00

java.lang.String authorization

The ID of the authorization being used to capture the payment.

payments.command.api.APICardCommand card

Credit or debit card being used to apply the payment to.

java.lang.String card.addressCity

City of the cardholder. [max length: 50, min length: 2]

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]

java.lang.String card.addressLine1

Address of the cardholder. [max length: 255]

java.lang.String card.addressLine2

Address of the cardholder if needed. [max length: 255]

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. [max length: 255]

java.lang.String card.addressZip

Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 32]

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]

java.lang.String card.name

Name as it appears on the card. [max length: 50, min length: 2]

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String currency

Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] required

java.lang.String customer

ID of customer. If specified, card on file of customer will be used.

java.lang.String description

Free form text field to be used as a description of the payment. This field is echoed back with the payment on any find or list operations. [max length: 1024]

java.lang.String invoice

ID of invoice for which this payment is being made.

java.lang.String invoiceReference

Invoice reference number.

payments.command.api.APIOrderCreateCommand order

Detailed order information.

java.lang.String order.commodityCode

Standard classification code for products and services. [max length: 5]

java.lang.String order.customer

ID of the customer associated with the order.

java.lang.String order.customerEmail

Customer email address.

java.lang.String order.customerName

Customer name.

java.lang.String order.customerNote

Additional notes provided by the customer. [max length: 255]

java.lang.String order.customerReference

A merchant reference for the customer.

payments.command.api.APIOrderItemCreateCommand order.items

Detailed information about individual items contained in the order.

java.lang.Long order.items.amount

Cost of the item.

java.lang.String order.items.description

Description of the item.

java.lang.String order.items.name

Item name.

java.lang.String order.items.product

Product information associated with the item.

java.lang.Long order.items.quantity

Quantity of the item contained in the order [min value: 1, max value: 999999, default: 1] required

java.lang.String order.items.reference

A merchant reference for the item. [max length: 255]

java.lang.String order.items.tax

Taxes associated with the item.

java.lang.String order.merchantNote

Additional notes provided by the merchant. [max length: 255]

java.lang.String order.payment

ID of the payment associated with the order.

java.lang.String order.reference

A merchant reference for the order. [max length: 255]

payments.command.api.APIAddressCommand order.shippingAddress

Address the products are being shipped to.

java.lang.String order.shippingAddress.city

City, town, or municipality. [max length: 255, min length: 2]

java.lang.String order.shippingAddress.country

2-character country code. [max length: 2, min length: 2]

java.lang.String order.shippingAddress.line1

Street address. [max length: 255]

java.lang.String order.shippingAddress.line2

(Opt) Street address continued. [max length: 255]

java.lang.String order.shippingAddress.name

Name of the entity being shipped to. [max length: 255]

java.lang.String order.shippingAddress.state

State or province. [max length: 255]

java.lang.String order.shippingAddress.zip

Postal code. [max length: 32]

payments.command.api.APIAddressCommand order.shippingFromAddress

Address the products are being shipped from.

java.lang.String order.shippingFromAddress.city

City, town, or municipality. [max length: 255, min length: 2]

java.lang.String order.shippingFromAddress.country

2-character country code. [max length: 2, min length: 2]

java.lang.String order.shippingFromAddress.line1

Street address. [max length: 255]

java.lang.String order.shippingFromAddress.line2

(Opt) Street address continued. [max length: 255]

java.lang.String order.shippingFromAddress.name

Name of the entity performing the shipping. [max length: 255]

java.lang.String order.shippingFromAddress.state

State or province. [max length: 255]

java.lang.String order.shippingFromAddress.zip

Postal code. [max length: 32]

java.lang.String order.shippingName

Name of the entity being shipped to.

java.lang.String order.source

Order source. [default: WEB] required

java.lang.String order.status

Status of the order. [default: INCOMPLETE] required

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 payment 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 payments. If supplied, we will check for a payment on your account that matches this identifier. If found will attempt to return an identical response 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.

java.lang.Boolean taxExempt

Specify true to indicate that the payment is tax-exempt.

java.lang.String token

If specified, card associated with card token will be used. [max length: 255]

Returns:

a Payment object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

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

Creates an Payment 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 payment (in the smallest unit of your currency). Example: 100 = $1.00

java.lang.String authorization

The ID of the authorization being used to capture the payment.

payments.command.api.APICardCommand card

Credit or debit card being used to apply the payment to.

java.lang.String card.addressCity

City of the cardholder. [max length: 50, min length: 2]

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]

java.lang.String card.addressLine1

Address of the cardholder. [max length: 255]

java.lang.String card.addressLine2

Address of the cardholder if needed. [max length: 255]

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. [max length: 255]

java.lang.String card.addressZip

Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 32]

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]

java.lang.String card.name

Name as it appears on the card. [max length: 50, min length: 2]

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String currency

Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] required

java.lang.String customer

ID of customer. If specified, card on file of customer will be used.

java.lang.String description

Free form text field to be used as a description of the payment. This field is echoed back with the payment on any find or list operations. [max length: 1024]

java.lang.String invoice

ID of invoice for which this payment is being made.

java.lang.String invoiceReference

Invoice reference number.

payments.command.api.APIOrderCreateCommand order

Detailed order information.

java.lang.String order.commodityCode

Standard classification code for products and services. [max length: 5]

java.lang.String order.customer

ID of the customer associated with the order.

java.lang.String order.customerEmail

Customer email address.

java.lang.String order.customerName

Customer name.

java.lang.String order.customerNote

Additional notes provided by the customer. [max length: 255]

java.lang.String order.customerReference

A merchant reference for the customer.

payments.command.api.APIOrderItemCreateCommand order.items

Detailed information about individual items contained in the order.

java.lang.Long order.items.amount

Cost of the item.

java.lang.String order.items.description

Description of the item.

java.lang.String order.items.name

Item name.

java.lang.String order.items.product

Product information associated with the item.

java.lang.Long order.items.quantity

Quantity of the item contained in the order [min value: 1, max value: 999999, default: 1] required

java.lang.String order.items.reference

A merchant reference for the item. [max length: 255]

java.lang.String order.items.tax

Taxes associated with the item.

java.lang.String order.merchantNote

Additional notes provided by the merchant. [max length: 255]

java.lang.String order.payment

ID of the payment associated with the order.

java.lang.String order.reference

A merchant reference for the order. [max length: 255]

payments.command.api.APIAddressCommand order.shippingAddress

Address the products are being shipped to.

java.lang.String order.shippingAddress.city

City, town, or municipality. [max length: 255, min length: 2]

java.lang.String order.shippingAddress.country

2-character country code. [max length: 2, min length: 2]

java.lang.String order.shippingAddress.line1

Street address. [max length: 255]

java.lang.String order.shippingAddress.line2

(Opt) Street address continued. [max length: 255]

java.lang.String order.shippingAddress.name

Name of the entity being shipped to. [max length: 255]

java.lang.String order.shippingAddress.state

State or province. [max length: 255]

java.lang.String order.shippingAddress.zip

Postal code. [max length: 32]

payments.command.api.APIAddressCommand order.shippingFromAddress

Address the products are being shipped from.

java.lang.String order.shippingFromAddress.city

City, town, or municipality. [max length: 255, min length: 2]

java.lang.String order.shippingFromAddress.country

2-character country code. [max length: 2, min length: 2]

java.lang.String order.shippingFromAddress.line1

Street address. [max length: 255]

java.lang.String order.shippingFromAddress.line2

(Opt) Street address continued. [max length: 255]

java.lang.String order.shippingFromAddress.name

Name of the entity performing the shipping. [max length: 255]

java.lang.String order.shippingFromAddress.state

State or province. [max length: 255]

java.lang.String order.shippingFromAddress.zip

Postal code. [max length: 32]

java.lang.String order.shippingName

Name of the entity being shipped to.

java.lang.String order.source

Order source. [default: WEB] required

java.lang.String order.status

Status of the order. [default: INCOMPLETE] required

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 payment 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 payments. If supplied, we will check for a payment on your account that matches this identifier. If found will attempt to return an identical response 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.

java.lang.Boolean taxExempt

Specify true to indicate that the payment is tax-exempt.

java.lang.String token

If specified, card associated with card token will be used. [max length: 255]

Returns:

a Payment object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

list

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

Retrieve Payment 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 Payment objects and the total number of Payment objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

@Deprecated
public static ResourceList<Payment> 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 Payment 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 Payment objects and the total number of Payment objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Retrieve Payment 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 Payment objects and the total number of Payment objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Retrieve Payment 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 payment Id
filter.replayId	Filter by the compoundReplayId
filter.last4	Filter by the card number (last 4 digits)
filter.amount	Filter by the payment amount (in the smallest unit of your currency)
filter.text	Filter by the description of the payment
filter.amountMin & filter.amountMax	The filter amountMin must be used with amountMax to find payments with payments amounts between the min and max figures
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 connected to the payment
filter.customer	Filter using the Id of the customer to find the payments for that customer
filter.status	Filter by the payment status text
filter.reference	Filter by the payment reference text
filter.authCode	Filter by the payment authorization code (Not the authorization ID)
filter.q	You can use this to filter by the Id, the authCode or the amount of the payment

^*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: dateCreated createdBy amount id description paymentDate .

Returns:

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Payment> 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 Payment 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 payment Id
filter.replayId	Filter by the compoundReplayId
filter.last4	Filter by the card number (last 4 digits)
filter.amount	Filter by the payment amount (in the smallest unit of your currency)
filter.text	Filter by the description of the payment
filter.amountMin & filter.amountMax	The filter amountMin must be used with amountMax to find payments with payments amounts between the min and max figures
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 connected to the payment
filter.customer	Filter using the Id of the customer to find the payments for that customer
filter.status	Filter by the payment status text
filter.reference	Filter by the payment reference text
filter.authCode	Filter by the payment authorization code (Not the authorization ID)
filter.q	You can use this to filter by the Id, the authCode or the amount of the payment

^*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: dateCreated createdBy amount id description 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 Payment objects and the total number of Payment objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Retrieve Payment 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 payment Id
filter.replayId	Filter by the compoundReplayId
filter.last4	Filter by the card number (last 4 digits)
filter.amount	Filter by the payment amount (in the smallest unit of your currency)
filter.text	Filter by the description of the payment
filter.amountMin & filter.amountMax	The filter amountMin must be used with amountMax to find payments with payments amounts between the min and max figures
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 connected to the payment
filter.customer	Filter using the Id of the customer to find the payments for that customer
filter.status	Filter by the payment status text
filter.reference	Filter by the payment reference text
filter.authCode	Filter by the payment authorization code (Not the authorization ID)
filter.q	You can use this to filter by the Id, the authCode or the amount of the payment

^*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: dateCreated createdBy amount id description paymentDate .

Returns:

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

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

Retrieve a Payment 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 Payment object to retrieve

Returns:

a Payment object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static Payment 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 Payment 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 Payment object to retrieve

Returns:

a Payment object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

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

Retrieve a Payment 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 Payment object to retrieve

Returns:

a Payment object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

update

public Payment update()
               throws ApiCommunicationException,
                      AuthenticationException,
                      InvalidRequestException,
                      ObjectNotFoundException,
                      NotAllowedException,
                      SystemException

Updates an Payment object. The properties that can be updated:

Returns:

a Payment object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException