Transaction extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_account : mixed
- $_action_result : mixed
- $_amount : mixed
- $_avs_check : mixed
- $_backup_payment_method_used : mixed
- $_billing_address : mixed
- $_collected_at : mixed
- $_collection_method : mixed
- $_created_at : mixed
- $_currency : mixed
- $_customer_message : mixed
- $_customer_message_locale : mixed
- $_cvv_check : mixed
- $_fraud_info : mixed
- $_gateway_approval_code : mixed
- $_gateway_message : mixed
- $_gateway_reference : mixed
- $_gateway_response_code : mixed
- $_gateway_response_time : mixed
- $_gateway_response_values : mixed
- $_id : mixed
- $_indicator : mixed
- $_invoice : mixed
- $_ip_address_country : mixed
- $_ip_address_v4 : mixed
- $_merchant_reason_code : mixed
- $_object : mixed
- $_origin : mixed
- $_original_transaction_id : mixed
- $_payment_gateway : mixed
- $_payment_method : mixed
- $_refunded : mixed
- $_response : mixed
- $_status : mixed
- $_status_code : mixed
- $_status_message : mixed
- $_subscription_ids : mixed
- $_success : mixed
- $_type : mixed
- $_updated_at : mixed
- $_uuid : mixed
- $_vat_number : mixed
- $_voided_at : mixed
- $_voided_by_invoice : mixed
- __construct() : mixed
- Constructor
- __debugInfo() : array<string|int, mixed>
- Override of the magic method __debugInfo that will only return the relevant attributes of the \Recurly\RecurlyResource
- __set() : void
- Guard against setting invalid properties
- cast() : RecurlyResource
- Recursively converts a response object into a \Recurly\RecurlyResource.
- fromBinary() : BinaryFile
- Converts a binary response into a Recurly BinaryFile
- fromEmpty() : EmptyResource
- Returns a \Recurly\EmptyResource for API requests that do not have a response body.
- fromResponse() : RecurlyResource
- Converts a Recurly response object into a \Recurly\RecurlyResource.
- getAccount() : AccountMini|null
- Getter method for the account attribute.
- getActionResult() : object|null
- Getter method for the action_result attribute.
- getAmount() : float|null
- Getter method for the amount attribute.
- getAvsCheck() : string|null
- Getter method for the avs_check attribute.
- getBackupPaymentMethodUsed() : bool|null
- Getter method for the backup_payment_method_used attribute.
- getBillingAddress() : AddressWithName|null
- Getter method for the billing_address attribute.
- getCollectedAt() : string|null
- Getter method for the collected_at attribute.
- getCollectionMethod() : string|null
- Getter method for the collection_method attribute.
- getCreatedAt() : string|null
- Getter method for the created_at attribute.
- getCurrency() : string|null
- Getter method for the currency attribute.
- getCustomerMessage() : string|null
- Getter method for the customer_message attribute.
- getCustomerMessageLocale() : string|null
- Getter method for the customer_message_locale attribute.
- getCvvCheck() : string|null
- Getter method for the cvv_check attribute.
- getFraudInfo() : TransactionFraudInfo|null
- Getter method for the fraud_info attribute.
- getGatewayApprovalCode() : string|null
- Getter method for the gateway_approval_code attribute.
- getGatewayMessage() : string|null
- Getter method for the gateway_message attribute.
- getGatewayReference() : string|null
- Getter method for the gateway_reference attribute.
- getGatewayResponseCode() : string|null
- Getter method for the gateway_response_code attribute.
- getGatewayResponseTime() : float|null
- Getter method for the gateway_response_time attribute.
- getGatewayResponseValues() : object|null
- Getter method for the gateway_response_values attribute.
- getId() : string|null
- Getter method for the id attribute.
- getIndicator() : string|null
- Getter method for the indicator attribute.
- getInvoice() : InvoiceMini|null
- Getter method for the invoice attribute.
- getIpAddressCountry() : string|null
- Getter method for the ip_address_country attribute.
- getIpAddressV4() : string|null
- Getter method for the ip_address_v4 attribute.
- getMerchantReasonCode() : string|null
- Getter method for the merchant_reason_code attribute.
- getObject() : string|null
- Getter method for the object attribute.
- getOrigin() : string|null
- Getter method for the origin attribute.
- getOriginalTransactionId() : string|null
- Getter method for the original_transaction_id attribute.
- getPaymentGateway() : TransactionPaymentGateway|null
- Getter method for the payment_gateway attribute.
- getPaymentMethod() : PaymentMethod|null
- Getter method for the payment_method attribute.
- getRefunded() : bool|null
- Getter method for the refunded attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getStatus() : string|null
- Getter method for the status attribute.
- getStatusCode() : string|null
- Getter method for the status_code attribute.
- getStatusMessage() : string|null
- Getter method for the status_message attribute.
- getSubscriptionIds() : array<string|int, mixed>
- Getter method for the subscription_ids attribute.
- getSuccess() : bool|null
- Getter method for the success attribute.
- getType() : string|null
- Getter method for the type attribute.
- getUpdatedAt() : string|null
- Getter method for the updated_at attribute.
- getUuid() : string|null
- Getter method for the uuid attribute.
- getVatNumber() : string|null
- Getter method for the vat_number attribute.
- getVoidedAt() : string|null
- Getter method for the voided_at attribute.
- getVoidedByInvoice() : InvoiceMini|null
- Getter method for the voided_by_invoice attribute.
- setAccount() : void
- Setter method for the account attribute.
- setActionResult() : void
- Setter method for the action_result attribute.
- setAmount() : void
- Setter method for the amount attribute.
- setAvsCheck() : void
- Setter method for the avs_check attribute.
- setBackupPaymentMethodUsed() : void
- Setter method for the backup_payment_method_used attribute.
- setBillingAddress() : void
- Setter method for the billing_address attribute.
- setCollectedAt() : void
- Setter method for the collected_at attribute.
- setCollectionMethod() : void
- Setter method for the collection_method attribute.
- setCreatedAt() : void
- Setter method for the created_at attribute.
- setCurrency() : void
- Setter method for the currency attribute.
- setCustomerMessage() : void
- Setter method for the customer_message attribute.
- setCustomerMessageLocale() : void
- Setter method for the customer_message_locale attribute.
- setCvvCheck() : void
- Setter method for the cvv_check attribute.
- setFraudInfo() : void
- Setter method for the fraud_info attribute.
- setGatewayApprovalCode() : void
- Setter method for the gateway_approval_code attribute.
- setGatewayMessage() : void
- Setter method for the gateway_message attribute.
- setGatewayReference() : void
- Setter method for the gateway_reference attribute.
- setGatewayResponseCode() : void
- Setter method for the gateway_response_code attribute.
- setGatewayResponseTime() : void
- Setter method for the gateway_response_time attribute.
- setGatewayResponseValues() : void
- Setter method for the gateway_response_values attribute.
- setId() : void
- Setter method for the id attribute.
- setIndicator() : void
- Setter method for the indicator attribute.
- setInvoice() : void
- Setter method for the invoice attribute.
- setIpAddressCountry() : void
- Setter method for the ip_address_country attribute.
- setIpAddressV4() : void
- Setter method for the ip_address_v4 attribute.
- setMerchantReasonCode() : void
- Setter method for the merchant_reason_code attribute.
- setObject() : void
- Setter method for the object attribute.
- setOrigin() : void
- Setter method for the origin attribute.
- setOriginalTransactionId() : void
- Setter method for the original_transaction_id attribute.
- setPaymentGateway() : void
- Setter method for the payment_gateway attribute.
- setPaymentMethod() : void
- Setter method for the payment_method attribute.
- setRefunded() : void
- Setter method for the refunded attribute.
- setStatus() : void
- Setter method for the status attribute.
- setStatusCode() : void
- Setter method for the status_code attribute.
- setStatusMessage() : void
- Setter method for the status_message attribute.
- setSubscriptionIds() : void
- Setter method for the subscription_ids attribute.
- setSuccess() : void
- Setter method for the success attribute.
- setType() : void
- Setter method for the type attribute.
- setUpdatedAt() : void
- Setter method for the updated_at attribute.
- setUuid() : void
- Setter method for the uuid attribute.
- setVatNumber() : void
- Setter method for the vat_number attribute.
- setVoidedAt() : void
- Setter method for the voided_at attribute.
- setVoidedByInvoice() : void
- Setter method for the voided_by_invoice attribute.
- encodeApiKey() : string
- Base64 encodes the API key
- getUserAgent() : string
- Generates User-Agent for API requests
- hintArrayType() : string
- The hintArrayType method will provide type hinting for setter methods that have array parameters.
- resourceClass() : string
- Converts a string into a representation of a Recurly Resource
- setResponse() : void
- Setter for the Recurly HTTP Response
- setterParamClass() : string
- Uses the Reflection API to determine what \Recurly\RecurlyResource is the expected parameter for the given method.
- titleize() : string
- Capitalizes all the words in the $input.
Properties
$array_hints
protected
static mixed
$array_hints
= ['setSubscriptionIds' => 'string']
$_account
private
mixed
$_account
$_action_result
private
mixed
$_action_result
$_amount
private
mixed
$_amount
$_avs_check
private
mixed
$_avs_check
$_backup_payment_method_used
private
mixed
$_backup_payment_method_used
$_billing_address
private
mixed
$_billing_address
$_collected_at
private
mixed
$_collected_at
$_collection_method
private
mixed
$_collection_method
$_created_at
private
mixed
$_created_at
$_currency
private
mixed
$_currency
$_customer_message
private
mixed
$_customer_message
$_customer_message_locale
private
mixed
$_customer_message_locale
$_cvv_check
private
mixed
$_cvv_check
$_fraud_info
private
mixed
$_fraud_info
$_gateway_approval_code
private
mixed
$_gateway_approval_code
$_gateway_message
private
mixed
$_gateway_message
$_gateway_reference
private
mixed
$_gateway_reference
$_gateway_response_code
private
mixed
$_gateway_response_code
$_gateway_response_time
private
mixed
$_gateway_response_time
$_gateway_response_values
private
mixed
$_gateway_response_values
$_id
private
mixed
$_id
$_indicator
private
mixed
$_indicator
$_invoice
private
mixed
$_invoice
$_ip_address_country
private
mixed
$_ip_address_country
$_ip_address_v4
private
mixed
$_ip_address_v4
$_merchant_reason_code
private
mixed
$_merchant_reason_code
$_object
private
mixed
$_object
$_origin
private
mixed
$_origin
$_original_transaction_id
private
mixed
$_original_transaction_id
$_payment_gateway
private
mixed
$_payment_gateway
$_payment_method
private
mixed
$_payment_method
$_refunded
private
mixed
$_refunded
$_response
private
mixed
$_response
$_status
private
mixed
$_status
$_status_code
private
mixed
$_status_code
$_status_message
private
mixed
$_status_message
$_subscription_ids
private
mixed
$_subscription_ids
$_success
private
mixed
$_success
$_type
private
mixed
$_type
$_updated_at
private
mixed
$_updated_at
$_uuid
private
mixed
$_uuid
$_vat_number
private
mixed
$_vat_number
$_voided_at
private
mixed
$_voided_at
$_voided_by_invoice
private
mixed
$_voided_by_invoice
Methods
__construct()
Constructor
public
final __construct() : mixed
Return values
mixed —__debugInfo()
Override of the magic method __debugInfo that will only return the relevant attributes of the \Recurly\RecurlyResource
public
__debugInfo() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —__set()
Guard against setting invalid properties
public
__set(string $key, mixed $value) : void
Parameters
- $key : string
-
The parameter name that is being set
- $value : mixed
-
The parameter value that is being set
Tags
Return values
void —cast()
Recursively converts a response object into a \Recurly\RecurlyResource.
public
static cast(object $data) : RecurlyResource
Parameters
- $data : object
-
PHP Object containing the decoded JSON
Return values
RecurlyResource —An instance of a Recurly Resource
fromBinary()
Converts a binary response into a Recurly BinaryFile
public
static fromBinary(string $data, Response $response) : BinaryFile
Parameters
- $data : string
-
The binary file data
- $response : Response
-
(optional) The Recurly HTTP Response
Return values
BinaryFile —An instance of a Recurly BinaryFile
fromEmpty()
Returns a \Recurly\EmptyResource for API requests that do not have a response body.
public
static fromEmpty(Response $response) : EmptyResource
Parameters
- $response : Response
-
(optional) The Recurly HTTP Response
Return values
EmptyResource —fromResponse()
Converts a Recurly response object into a \Recurly\RecurlyResource.
public
static fromResponse(Response $response[, object $json = null ]) : RecurlyResource
Parameters
- $response : Response
-
The Recurly HTTP Response
- $json : object = null
-
(optional) JSON payload to use instead of the $response's. Primarily used for errors
Return values
RecurlyResource —An instance of a Recurly Resource
getAccount()
Getter method for the account attribute.
public
getAccount() : AccountMini|null
Account mini details
Return values
AccountMini|null —getActionResult()
Getter method for the action_result attribute.
public
getActionResult() : object|null
Action result params to be used in Recurly-JS to complete a payment when using asynchronous payment methods, e.g., Boleto, iDEAL and Sofort.
Return values
object|null —getAmount()
Getter method for the amount attribute.
public
getAmount() : float|null
Total transaction amount sent to the payment gateway.
Return values
float|null —getAvsCheck()
Getter method for the avs_check attribute.
public
getAvsCheck() : string|null
When processed, result from checking the overall AVS on the transaction.
Return values
string|null —getBackupPaymentMethodUsed()
Getter method for the backup_payment_method_used attribute.
public
getBackupPaymentMethodUsed() : bool|null
Indicates if the transaction was completed using a backup payment
Return values
bool|null —getBillingAddress()
Getter method for the billing_address attribute.
public
getBillingAddress() : AddressWithName|null
Return values
AddressWithName|null —getCollectedAt()
Getter method for the collected_at attribute.
public
getCollectedAt() : string|null
Collected at, or if not collected yet, the time the transaction was created.
Return values
string|null —getCollectionMethod()
Getter method for the collection_method attribute.
public
getCollectionMethod() : string|null
The method by which the payment was collected.
Return values
string|null —getCreatedAt()
Getter method for the created_at attribute.
public
getCreatedAt() : string|null
Created at
Return values
string|null —getCurrency()
Getter method for the currency attribute.
public
getCurrency() : string|null
3-letter ISO 4217 currency code.
Return values
string|null —getCustomerMessage()
Getter method for the customer_message attribute.
public
getCustomerMessage() : string|null
For declined (success=false) transactions, the message displayed to the customer.
Return values
string|null —getCustomerMessageLocale()
Getter method for the customer_message_locale attribute.
public
getCustomerMessageLocale() : string|null
Language code for the message
Return values
string|null —getCvvCheck()
Getter method for the cvv_check attribute.
public
getCvvCheck() : string|null
When processed, result from checking the CVV/CVC value on the transaction.
Return values
string|null —getFraudInfo()
Getter method for the fraud_info attribute.
public
getFraudInfo() : TransactionFraudInfo|null
Fraud information
Return values
TransactionFraudInfo|null —getGatewayApprovalCode()
Getter method for the gateway_approval_code attribute.
public
getGatewayApprovalCode() : string|null
Transaction approval code from the payment gateway.
Return values
string|null —getGatewayMessage()
Getter method for the gateway_message attribute.
public
getGatewayMessage() : string|null
Transaction message from the payment gateway.
Return values
string|null —getGatewayReference()
Getter method for the gateway_reference attribute.
public
getGatewayReference() : string|null
Transaction reference number from the payment gateway.
Return values
string|null —getGatewayResponseCode()
Getter method for the gateway_response_code attribute.
public
getGatewayResponseCode() : string|null
For declined transactions (success=false), this field lists the gateway error code.
Return values
string|null —getGatewayResponseTime()
Getter method for the gateway_response_time attribute.
public
getGatewayResponseTime() : float|null
Time, in seconds, for gateway to process the transaction.
Return values
float|null —getGatewayResponseValues()
Getter method for the gateway_response_values attribute.
public
getGatewayResponseValues() : object|null
The values in this field will vary from gateway to gateway.
Return values
object|null —getId()
Getter method for the id attribute.
public
getId() : string|null
Transaction ID
Return values
string|null —getIndicator()
Getter method for the indicator attribute.
public
getIndicator() : string|null
Must be sent for one-time transactions in order to provide context on which entity is submitting the transaction to ensure proper fraud checks are observed, such as 3DS. If the customer is in session, send customer. If this is a merchant initiated one-time transaction, send merchant.
Return values
string|null —getInvoice()
Getter method for the invoice attribute.
public
getInvoice() : InvoiceMini|null
Invoice mini details
Return values
InvoiceMini|null —getIpAddressCountry()
Getter method for the ip_address_country attribute.
public
getIpAddressCountry() : string|null
Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known by Recurly.
Return values
string|null —getIpAddressV4()
Getter method for the ip_address_v4 attribute.
public
getIpAddressV4() : string|null
IP address provided when the billing information was collected:
- When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address.
- When the merchant enters billing information using the API, the merchant may provide an IP address.
- When the merchant enters billing information using the UI, no IP address is recorded.
Return values
string|null —getMerchantReasonCode()
Getter method for the merchant_reason_code attribute.
public
getMerchantReasonCode() : string|null
This conditional parameter is useful for merchants in specific industries who need to submit one-time Merchant Initiated transactions in specific cases. Not all gateways support these methods, but will support a generic one-time Merchant Initiated transaction. Only use this if the initiator value is "merchant". Otherwise, it will be ignored.
- Incremental: Send
incrementalwith an additional purchase if the original authorization amount is not sufficient to cover the costs of your service or product. For example, if the customer adds goods or services or there are additional expenses. - No Show: Send
no_showif you charge customers a fee due to an agreed-upon cancellation policy in your industry. - Resubmission: Send
resubmissionif you need to attempt collection on a declined transaction. You may also use the force collection behavior which has the same effect. - Service Extension: Send
service_extensionif you are in a service industry and the customer has increased/extended their service in some way. For example: adding a day onto a car rental agreement. - Split Shipment: Send
split_shipmentif you sell physical product and need to split up a shipment into multiple transactions when the customer is no longer in session. - Top Up: Send
top_upif you process one-time transactions based on a pre-arranged agreement with your customer where there is a pre-arranged account balance that needs maintaining. For example, if the customer has agreed to maintain an account balance of 30.00 and their current balance is 20.00, the MIT amount would be at least 10.00 to meet that 30.00 threshold.
Return values
string|null —getObject()
Getter method for the object attribute.
public
getObject() : string|null
Object type
Return values
string|null —getOrigin()
Getter method for the origin attribute.
public
getOrigin() : string|null
Describes how the transaction was triggered.
Return values
string|null —getOriginalTransactionId()
Getter method for the original_transaction_id attribute.
public
getOriginalTransactionId() : string|null
If this transaction is a refund (type=refund), this will be the ID of the original transaction on the invoice being refunded.
Return values
string|null —getPaymentGateway()
Getter method for the payment_gateway attribute.
public
getPaymentGateway() : TransactionPaymentGateway|null
Return values
TransactionPaymentGateway|null —getPaymentMethod()
Getter method for the payment_method attribute.
public
getPaymentMethod() : PaymentMethod|null
Return values
PaymentMethod|null —getRefunded()
Getter method for the refunded attribute.
public
getRefunded() : bool|null
Indicates if part or all of this transaction was refunded.
Return values
bool|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getStatus()
Getter method for the status attribute.
public
getStatus() : string|null
The current transaction status. Note that the status may change, e.g. a pending transaction may become declined or success may later become void.
Return values
string|null —getStatusCode()
Getter method for the status_code attribute.
public
getStatusCode() : string|null
Status code
Return values
string|null —getStatusMessage()
Getter method for the status_message attribute.
public
getStatusMessage() : string|null
For declined (success=false) transactions, the message displayed to the merchant.
Return values
string|null —getSubscriptionIds()
Getter method for the subscription_ids attribute.
public
getSubscriptionIds() : array<string|int, mixed>
If the transaction is charging or refunding for one or more subscriptions, these are their IDs.
Return values
array<string|int, mixed> —getSuccess()
Getter method for the success attribute.
public
getSuccess() : bool|null
Did this transaction complete successfully?
Return values
bool|null —getType()
Getter method for the type attribute.
public
getType() : string|null
-
authorization– verifies billing information and places a hold on money in the customer's account. -
capture– captures funds held by an authorization and completes a purchase. -
purchase– combines the authorization and capture in one transaction. -
refund– returns all or a portion of the money collected in a previous transaction to the customer. -
verify– a $0 or $1 transaction used to verify billing information which is immediately voided.
Return values
string|null —getUpdatedAt()
Getter method for the updated_at attribute.
public
getUpdatedAt() : string|null
Updated at
Return values
string|null —getUuid()
Getter method for the uuid attribute.
public
getUuid() : string|null
The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
Return values
string|null —getVatNumber()
Getter method for the vat_number attribute.
public
getVatNumber() : string|null
VAT number for the customer on this transaction. If the customer's Billing Info country is BR or AR, then this will be their Tax Identifier. For all other countries this will come from the VAT Number field in the Billing Info.
Return values
string|null —getVoidedAt()
Getter method for the voided_at attribute.
public
getVoidedAt() : string|null
Voided at
Return values
string|null —getVoidedByInvoice()
Getter method for the voided_by_invoice attribute.
public
getVoidedByInvoice() : InvoiceMini|null
Invoice mini details
Return values
InvoiceMini|null —setAccount()
Setter method for the account attribute.
public
setAccount(AccountMini $account) : void
Parameters
- $account : AccountMini
Return values
void —setActionResult()
Setter method for the action_result attribute.
public
setActionResult(object $action_result) : void
Parameters
- $action_result : object
Return values
void —setAmount()
Setter method for the amount attribute.
public
setAmount(float $amount) : void
Parameters
- $amount : float
Return values
void —setAvsCheck()
Setter method for the avs_check attribute.
public
setAvsCheck(string $avs_check) : void
Parameters
- $avs_check : string
Return values
void —setBackupPaymentMethodUsed()
Setter method for the backup_payment_method_used attribute.
public
setBackupPaymentMethodUsed(bool $backup_payment_method_used) : void
Parameters
- $backup_payment_method_used : bool
Return values
void —setBillingAddress()
Setter method for the billing_address attribute.
public
setBillingAddress(AddressWithName $billing_address) : void
Parameters
- $billing_address : AddressWithName
Return values
void —setCollectedAt()
Setter method for the collected_at attribute.
public
setCollectedAt(string $collected_at) : void
Parameters
- $collected_at : string
Return values
void —setCollectionMethod()
Setter method for the collection_method attribute.
public
setCollectionMethod(string $collection_method) : void
Parameters
- $collection_method : string
Return values
void —setCreatedAt()
Setter method for the created_at attribute.
public
setCreatedAt(string $created_at) : void
Parameters
- $created_at : string
Return values
void —setCurrency()
Setter method for the currency attribute.
public
setCurrency(string $currency) : void
Parameters
- $currency : string
Return values
void —setCustomerMessage()
Setter method for the customer_message attribute.
public
setCustomerMessage(string $customer_message) : void
Parameters
- $customer_message : string
Return values
void —setCustomerMessageLocale()
Setter method for the customer_message_locale attribute.
public
setCustomerMessageLocale(string $customer_message_locale) : void
Parameters
- $customer_message_locale : string
Return values
void —setCvvCheck()
Setter method for the cvv_check attribute.
public
setCvvCheck(string $cvv_check) : void
Parameters
- $cvv_check : string
Return values
void —setFraudInfo()
Setter method for the fraud_info attribute.
public
setFraudInfo(TransactionFraudInfo $fraud_info) : void
Parameters
- $fraud_info : TransactionFraudInfo
Return values
void —setGatewayApprovalCode()
Setter method for the gateway_approval_code attribute.
public
setGatewayApprovalCode(string $gateway_approval_code) : void
Parameters
- $gateway_approval_code : string
Return values
void —setGatewayMessage()
Setter method for the gateway_message attribute.
public
setGatewayMessage(string $gateway_message) : void
Parameters
- $gateway_message : string
Return values
void —setGatewayReference()
Setter method for the gateway_reference attribute.
public
setGatewayReference(string $gateway_reference) : void
Parameters
- $gateway_reference : string
Return values
void —setGatewayResponseCode()
Setter method for the gateway_response_code attribute.
public
setGatewayResponseCode(string $gateway_response_code) : void
Parameters
- $gateway_response_code : string
Return values
void —setGatewayResponseTime()
Setter method for the gateway_response_time attribute.
public
setGatewayResponseTime(float $gateway_response_time) : void
Parameters
- $gateway_response_time : float
Return values
void —setGatewayResponseValues()
Setter method for the gateway_response_values attribute.
public
setGatewayResponseValues(object $gateway_response_values) : void
Parameters
- $gateway_response_values : object
Return values
void —setId()
Setter method for the id attribute.
public
setId(string $id) : void
Parameters
- $id : string
Return values
void —setIndicator()
Setter method for the indicator attribute.
public
setIndicator(string $indicator) : void
Parameters
- $indicator : string
Return values
void —setInvoice()
Setter method for the invoice attribute.
public
setInvoice(InvoiceMini $invoice) : void
Parameters
- $invoice : InvoiceMini
Return values
void —setIpAddressCountry()
Setter method for the ip_address_country attribute.
public
setIpAddressCountry(string $ip_address_country) : void
Parameters
- $ip_address_country : string
Return values
void —setIpAddressV4()
Setter method for the ip_address_v4 attribute.
public
setIpAddressV4(string $ip_address_v4) : void
Parameters
- $ip_address_v4 : string
Return values
void —setMerchantReasonCode()
Setter method for the merchant_reason_code attribute.
public
setMerchantReasonCode(string $merchant_reason_code) : void
Parameters
- $merchant_reason_code : string
Return values
void —setObject()
Setter method for the object attribute.
public
setObject(string $object) : void
Parameters
- $object : string
Return values
void —setOrigin()
Setter method for the origin attribute.
public
setOrigin(string $origin) : void
Parameters
- $origin : string
Return values
void —setOriginalTransactionId()
Setter method for the original_transaction_id attribute.
public
setOriginalTransactionId(string $original_transaction_id) : void
Parameters
- $original_transaction_id : string
Return values
void —setPaymentGateway()
Setter method for the payment_gateway attribute.
public
setPaymentGateway(TransactionPaymentGateway $payment_gateway) : void
Parameters
- $payment_gateway : TransactionPaymentGateway
Return values
void —setPaymentMethod()
Setter method for the payment_method attribute.
public
setPaymentMethod(PaymentMethod $payment_method) : void
Parameters
- $payment_method : PaymentMethod
Return values
void —setRefunded()
Setter method for the refunded attribute.
public
setRefunded(bool $refunded) : void
Parameters
- $refunded : bool
Return values
void —setStatus()
Setter method for the status attribute.
public
setStatus(string $status) : void
Parameters
- $status : string
Return values
void —setStatusCode()
Setter method for the status_code attribute.
public
setStatusCode(string $status_code) : void
Parameters
- $status_code : string
Return values
void —setStatusMessage()
Setter method for the status_message attribute.
public
setStatusMessage(string $status_message) : void
Parameters
- $status_message : string
Return values
void —setSubscriptionIds()
Setter method for the subscription_ids attribute.
public
setSubscriptionIds(array<string|int, mixed> $subscription_ids) : void
Parameters
- $subscription_ids : array<string|int, mixed>
Return values
void —setSuccess()
Setter method for the success attribute.
public
setSuccess(bool $success) : void
Parameters
- $success : bool
Return values
void —setType()
Setter method for the type attribute.
public
setType(string $type) : void
Parameters
- $type : string
Return values
void —setUpdatedAt()
Setter method for the updated_at attribute.
public
setUpdatedAt(string $updated_at) : void
Parameters
- $updated_at : string
Return values
void —setUuid()
Setter method for the uuid attribute.
public
setUuid(string $uuid) : void
Parameters
- $uuid : string
Return values
void —setVatNumber()
Setter method for the vat_number attribute.
public
setVatNumber(string $vat_number) : void
Parameters
- $vat_number : string
Return values
void —setVoidedAt()
Setter method for the voided_at attribute.
public
setVoidedAt(string $voided_at) : void
Parameters
- $voided_at : string
Return values
void —setVoidedByInvoice()
Setter method for the voided_by_invoice attribute.
public
setVoidedByInvoice(InvoiceMini $voided_by_invoice) : void
Parameters
- $voided_by_invoice : InvoiceMini
Return values
void —encodeApiKey()
Base64 encodes the API key
protected
static encodeApiKey(string $key) : string
Parameters
- $key : string
-
The API key to encode
Return values
string —base64 encoded API key
getUserAgent()
Generates User-Agent for API requests
protected
static getUserAgent() : string
Return values
string —Recurly client User-Agent string
hintArrayType()
The hintArrayType method will provide type hinting for setter methods that have array parameters.
protected
static hintArrayType(string $key) : string
Parameters
- $key : string
-
The property to get teh type hint for.
Return values
string —The class name of the expected array type.
resourceClass()
Converts a string into a representation of a Recurly Resource
protected
static resourceClass(string $type) : string
Parameters
- $type : string
-
A string to convert to a Recurly Resource
Return values
string —The string representation of a Recurly Resource
setResponse()
Setter for the Recurly HTTP Response
protected
setResponse(Response $response) : void
Parameters
- $response : Response
-
The Recurly HTTP Response
Return values
void —setterParamClass()
Uses the Reflection API to determine what \Recurly\RecurlyResource is the expected parameter for the given method.
protected
static setterParamClass(string $method) : string
Parameters
- $method : string
-
The name of the setter method to find the type hint for
Return values
string —The \Recurly\RecurlyResource that the setter method expects
titleize()
Capitalizes all the words in the $input.
protected
static titleize(string $input[, string $prefix = '' ]) : string
Parameters
- $input : string
-
The string to titleize
- $prefix : string = ''
-
(optional) Prefix to add to the beginning of the titleized string. The prefix will not be titleized.
Return values
string —The titleized $input wtih the prepended $prefix