\Simplify_Payment

Base class for all domain objects.

Summary

Methods
Properties
Constants
createPayment()
listPayment()
findPayment()
updatePayment()
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

createPayment()

createPayment(array $hash, mixed $authentication) : \Payment

Creates an Simplify_Payment object

Parameters

array $hash

a map of parameters; valid keys are:

amount
Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00
authorization
The ID of the authorization being used to capture the payment.
card.addressCity
City of the cardholder. [max length: 50, min length: 2]
card.addressCountry
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
card.addressLine1
Address of the cardholder. [max length: 255]
card.addressLine2
Address of the cardholder if needed. [max length: 255]
card.addressState
State of residence of the cardholder. State abbreviations should be used. [max length: 255]
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]
card.cvc
CVC security code of the card. This is the code on the back of the card. Example: 123
card.expMonth
Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]
card.expYear
Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]
card.name
Name as it appears on the card. [max length: 50, min length: 2]
card.number
Card number as it appears on the card. [max length: 19, min length: 13]
currency
Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] required
customer
ID of customer. If specified, card on file of customer will be used.
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]
invoice
ID of invoice for which this payment is being made.
invoiceReference
Invoice reference number.
order.commodityCode
Standard classification code for products and services. [max length: 5]
order.customer
ID of the customer associated with the order.
order.customerEmail
Customer email address.
order.customerName
Customer name.
order.customerNote
Additional notes provided by the customer. [max length: 255]
order.customerReference
A merchant reference for the customer.
order.items.amount
Cost of the item.
order.items.description
Description of the item.
order.items.name
Item name.
order.items.product
Product information associated with the item.
order.items.quantity
Quantity of the item contained in the order [min value: 1, max value: 999999, default: 1] required
order.items.reference
A merchant reference for the item. [max length: 255]
order.items.tax
Taxes associated with the item.
order.merchantNote
Additional notes provided by the merchant. [max length: 255]
order.payment
ID of the payment associated with the order.
order.reference
A merchant reference for the order. [max length: 255]
order.shippingAddress.city
City, town, or municipality. [max length: 255, min length: 2]
order.shippingAddress.country
2-character country code. [max length: 2, min length: 2]
order.shippingAddress.line1
Street address. [max length: 255]
order.shippingAddress.line2
(Opt) Street address continued. [max length: 255]
order.shippingAddress.name
Name of the entity being shipped to. [max length: 255]
order.shippingAddress.state
State or province. [max length: 255]
order.shippingAddress.zip
Postal code. [max length: 32]
order.shippingFromAddress.city
City, town, or municipality. [max length: 255, min length: 2]
order.shippingFromAddress.country
2-character country code. [max length: 2, min length: 2]
order.shippingFromAddress.line1
Street address. [max length: 255]
order.shippingFromAddress.line2
(Opt) Street address continued. [max length: 255]
order.shippingFromAddress.name
Name of the entity performing the shipping. [max length: 255]
order.shippingFromAddress.state
State or province. [max length: 255]
order.shippingFromAddress.zip
Postal code. [max length: 32]
order.shippingName
Name of the entity being shipped to.
order.source
Order source. [default: WEB] required
order.status
Status of the order. [default: INCOMPLETE] required
reference
Custom reference field to be used with outside systems.
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]
statementDescription.name
Merchant name. required
statementDescription.phoneNumber
Merchant contact phone number.
taxExempt
Specify true to indicate that the payment is tax-exempt.
token
If specified, card associated with card token will be used. [max length: 255]
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

\Payment —

a Payment object.

listPayment()

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

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

findPayment()

findPayment( $id, mixed $authentication) : \Payment

Retrieve a Simplify_Payment 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

\Payment —

a Payment object

updatePayment()

updatePayment(mixed $authentication) : \Payment

Updates an Simplify_Payment object.

The properties that can be updated:

Parameters

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

\Payment —

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