Class Syspay_Merchant_Entity_Payment

A payment object

Syspay_Merchant_Entity_Payment implements Syspay_Merchant_Entity_ReturnedEntityInterface

Located at Syspay/SDK/Merchant/Entity/Payment.php

Methods summary
`public string`	# `getReference( )` Gets the value of reference. Gets the value of reference. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setReference( string $reference )` Sets the value of reference. Sets the value of reference. Parameters `$reference` the reference Returns `Syspay_Merchant_Entity_Payment` self
`public integer`	# `getAmount( )` Gets the value of amount. Gets the value of amount. Returns `integer` integer
`public Syspay_Merchant_Entity_Payment`	# `setAmount( integer $amount )` Sets the value of amount. Sets the value of amount. Parameters `$amount` the amount Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getCurrency( )` Gets the value of currency. Gets the value of currency. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setCurrency( string $currency )` Sets the value of currency. Sets the value of currency. Parameters `$currency` the currency Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getDescription( )` Gets the value of description. Gets the value of description. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setDescription( string $description )` Sets the value of description. Sets the value of description. Parameters `$description` the description Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getExtra( )` Gets the value of extra. Gets the value of extra. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setExtra( string $extra )` Sets the value of extra. Sets the value of extra. Parameters `$extra` the extra Returns `Syspay_Merchant_Entity_Payment` self
`public integer`	# `getId( )` Gets the value of id. Gets the value of id. Returns `integer` integer
`public Syspay_Merchant_Entity_Payment`	# `setId( integer $id )` Sets the value of id. Sets the value of id. Parameters `$id` the id Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getStatus( )` Gets the value of status. Gets the value of status. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setStatus( string $status )` Sets the value of status. Sets the value of status. Parameters `$status` the status Returns `Syspay_Merchant_Entity_Payment` self
`public Syspay_Merchant_Entity_BillingAgreement`	# `getBillingAgreement( )` Gets the value of billing_agreement. Gets the value of billing_agreement. Returns `Syspay_Merchant_Entity_BillingAgreement` Syspay_Merchant_Entity_BillingAgreement
`public Syspay_Merchant_Entity_Payment`	# `setBillingAgreement( Syspay_Merchant_Entity_BillingAgreement $billingAgreement )` Sets the value of billing_agreement. Sets the value of billing_agreement. Parameters `$billingAgreement` $billing_agreement the billing_agreement Returns `Syspay_Merchant_Entity_Payment` self
`public Syspay_Merchant_Entity_Subscription`	# `getSubscription( )` Gets the value of subscription. Gets the value of subscription. Returns `Syspay_Merchant_Entity_Subscription` Syspay_Merchant_Entity_Subscription
`public Syspay_Merchant_Entity_Payment`	# `setSubscription( Syspay_Merchant_Entity_Subscription $subscription )` Sets the value of subscription. Sets the value of subscription. Parameters `$subscription` the subscription Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getRedirect( )` Gets the value of redirect. Gets the value of redirect. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setRedirect( string $redirect )` Sets the value of redirect. Sets the value of redirect. Parameters `$redirect` the redirect Returns `Syspay_Merchant_Entity_Payment` self
`public static Syspay_Merchant_Entity_Payment`	# `buildFromResponse( stdClass $response )` Build a payment entity based on a json-decoded payment stdClass Build a payment entity based on a json-decoded payment stdClass Parameters `$response` The payment data Returns `Syspay_Merchant_Entity_Payment` The payment object Implementation of `Syspay_Merchant_Entity_ReturnedEntityInterface::buildFromResponse()`
`public boolean`	# `getPreauth( )` Gets the value of preauth. Gets the value of preauth. Returns `boolean` boolean
`public Syspay_Merchant_Entity_Payment`	# `setPreauth( boolean $preauth )` Sets the value of preauth. Sets the value of preauth. Parameters `$preauth` the preauth Returns `Syspay_Merchant_Entity_Payment` self
`public integer`	# `getWebsite( )` Gets the value of website. Gets the value of website. Returns `integer` integer
`public Syspay_Merchant_Entity_Payment`	# `setWebsite( integer $website )` Sets the value of website. Sets the value of website. Parameters `$website` the website Returns `Syspay_Merchant_Entity_Payment` self
`public DateTime`	# `getProcessingTime( )` Gets the value of processingTime. Gets the value of processingTime. Returns `DateTime` DateTime
`public Syspay_Merchant_Entity_Payment`	# `setProcessingTime( DateTime $processingTime )` Sets the value of processingTime. Sets the value of processingTime. Parameters `$processingTime` the processingTime Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getFailureCategory( )` Gets the failure category, this is one of the FAILURE_* constants Gets the failure category, this is one of the FAILURE_* constants Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setFailureCategory( string $failureCategory )` Sets the value of failureCategory. Sets the value of failureCategory. Parameters `$failureCategory` the failureCategory Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getChipAndPinStatus( )` Gets the value of chipAndPinStatus. Gets the value of chipAndPinStatus. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setChipAndPinStatus( string $chipAndPinStatus )` Sets the value of chipAndPinStatus. Sets the value of chipAndPinStatus. Parameters `$chipAndPinStatus` the chipAndPinStatus Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getPaymentType( )` Gets the value of paymentType. Gets the value of paymentType. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setPaymentType( string $paymentType )` Sets the value of paymentType. Sets the value of paymentType. Parameters `$paymentType` the paymentType Returns `Syspay_Merchant_Entity_Payment` self
`public array`	# `getRecipientMap( )` Gets the value of recipient_map. Gets the value of recipient_map. Returns `array` array
`public Syspay_Merchant_Entity_Payment`	# `setRecipientMap( array $recipientMap )` Sets the value of recipient_map. Sets the value of recipient_map. Parameters `$recipientMap` An array of Syspay_Merchant_Entity_PaymentRecipient Returns `Syspay_Merchant_Entity_Payment` self
`public Syspay_Merchant_Entity_Payment`	# `addRecipient( Syspay_Merchant_Entity_PaymentRecipient $paymentRecipient )` Add a PaymentRecipient to the recipient map list Add a PaymentRecipient to the recipient map list Parameters `$paymentRecipient` Returns `Syspay_Merchant_Entity_Payment` self
`public array`	# `toArray( )` Get an array representation of the object to build the request. It will collect all protected properties. Get an array representation of the object to build the request. It will collect all protected properties. Returns `array` An array to be used in the request Overrides `Syspay_Merchant_Entity::toArray()`
`public DateTime`	# `getSettlementDate( )` Gets the value of settlementDate. Gets the value of settlementDate. Returns `DateTime` DateTime
`public Syspay_Merchant_Entity_Payment`	# `setSettlementDate( DateTime $settlementDate = null )` Sets the value of settlementDate. Sets the value of settlementDate. Parameters `$settlementDate` the settlement date Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getWebsiteUrl( )` Gets the value of websiteUrl. Gets the value of websiteUrl. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setWebsiteUrl( string $websiteUrl )` Sets the value of websiteUrl. Sets the value of websiteUrl. Parameters `$websiteUrl` the website url Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getContract( )` Gets the value of contract. Gets the value of contract. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setContract( string $contract )` Sets the value of contract. Sets the value of contract. Parameters `$contract` the contract Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getDescriptor( )` Gets the value of descriptor. Gets the value of descriptor. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setDescriptor( string $descriptor )` Sets the value of descriptor. Sets the value of descriptor. Parameters `$descriptor` the descriptor Returns `Syspay_Merchant_Entity_Payment` self
`public integer`	# `getAccountId( )` Gets the value of accountId. Gets the value of accountId. Returns `integer` integer
`public Syspay_Merchant_Entity_Payment`	# `setAccountId( integer $accountId )` Sets the value of accountId. Sets the value of accountId. Parameters `$accountId` the account id Returns `Syspay_Merchant_Entity_Payment` self
`public string`	# `getMerchantLogin( )` Gets the value of merchantLogin. Gets the value of merchantLogin. Returns `string` string
`public Syspay_Merchant_Entity_Payment`	# `setMerchantLogin( string $merchantLogin )` Sets the value of merchantLogin. Sets the value of merchantLogin. Parameters `$merchantLogin` the merchant login Returns `Syspay_Merchant_Entity_Payment` self
`public integer`	# `getMerchantId( )` Gets the value of merchantId. Gets the value of merchantId. Returns `integer` integer
`public Syspay_Merchant_Entity_Payment`	# `setMerchantId( integer $merchantId )` Sets the value of merchantId. Sets the value of merchantId. Parameters `$merchantId` the merchant id Returns `Syspay_Merchant_Entity_Payment` self
`public Syspay_Merchant_Entity_PaymentMethod`	# `getPaymentMethod( )` Gets the value of payment_method. Gets the value of payment_method. Returns `Syspay_Merchant_Entity_PaymentMethod` Syspay_Merchant_Entity_PaymentMethod
`public Syspay_Merchant_Entity_Payment`	# `setPaymentMethod( Syspay_Merchant_Entity_PaymentMethod $payment_method )` Sets the value of payment_method. Sets the value of payment_method. Parameters `$payment_method` the payment_method Returns `Syspay_Merchant_Entity_Payment` self
`public integer`	# `getSubscriptionCounter( )` Get the value of subscription_counter Get the value of subscription_counter Returns `integer` int
`public mixed`	# `setSubscriptionCounter( integer $subscription_counter )` Set the value of subscription_counter Set the value of subscription_counter Parameters `$subscription_counter` Returns `mixed` $this
`public integer`	# `getSubscriptionCounterType( )` Get the value of subscription_counter_type Get the value of subscription_counter_type Returns `integer` int
`public mixed`	# `setSubscriptionCounterType( integer $subscription_counter_type )` Set the value of subscription_counter_type Set the value of subscription_counter_type Parameters `$subscription_counter_type` Returns `mixed` $this
`public integer`	# `getSubscriptionAttempt( )` Get the value of subscription_attempt Get the value of subscription_attempt Returns `integer` int
`public mixed`	# `setSubscriptionAttempt( integer $subscription_attempt )` Set the value of subscription_attempt Set the value of subscription_attempt Parameters `$subscription_attempt` Returns `mixed` $this
`public DateTime`	# `getCaptureDate( )` Get the value of capture_date. Get the value of capture_date. Returns `DateTime` DateTime
`public mixed`	# `setCaptureDate( DateTime $capture_date = null )` Set the value of capture_date. Set the value of capture_date. Parameters `$capture_date` Returns `mixed` $this

Methods inherited from Syspay_Merchant_Entity
`getType()`

Constants summary
`string`	`TYPE`	#`'payment'`
`string`	`FAILURE_CARD_FLAGGED` The card has been flagged as lost or stolen The card has been flagged as lost or stolen See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'card_flagged'`
`string`	`FAILURE_DECLINED` The transaction has been declined by the acquirer The transaction has been declined by the acquirer See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'declined'`
`string`	`FAILURE_DUPLICATED` Two transactions with the same information have been attempted in a too short period Two transactions with the same information have been attempted in a too short period See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'duplicated'`
`string`	`FAILURE_EXPIRED` The card has expired The card has expired See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'expired'`
`string`	`FAILURE_FRAUD` The transaction has been refused for suspicion of fraud The transaction has been refused for suspicion of fraud See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'fraud_suspicious'`
`string`	`FAILURE_INSUFFICIENT_FUNDS` There wasn't enough money available to complete the transaction There wasn't enough money available to complete the transaction See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'insufficient_funds'`
`string`	`FAILURE_INVALID_CARD` The card number is not valid The card number is not valid See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'invalid_card'`
`string`	`FAILURE_INVALID_CV2` The CV2 is not valid The CV2 is not valid See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'invalid_cv2'`
`string`	`FAILURE_INVALID_DETAILS` The card information are not valid The card information are not valid See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'invalid_details'`
`string`	`FAILURE_OTHER` The transaction was refused by the acquirer but the reason could not be precisely determined The transaction was refused by the acquirer but the reason could not be precisely determined See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'other'`
`string`	`FAILURE_TECHNICAL_ERROR` A technical error occured while attempting to process the transaction A technical error occured while attempting to process the transaction See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'technical_error'`
`string`	`FAILURE_UNSUPPORTED` The card scheme is not supported The card scheme is not supported See `Syspay_Merchant_Entity_Payment::getFailureCategory()`	#`'unsupported'`

Properties inherited from Syspay_Merchant_Entity
`$raw`

Classes

Interfaces

Exceptions

Class Syspay_Merchant_Entity_Payment

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns