Payment
extends Entity
in package
This class provides the methods to access the API that will allow you to create your own payment experience on your website.
From basic to advanced configurations, you control the whole experience.
Tags
Table of Contents
- $_custom_headers : mixed
- $_empty : mixed
- $_last : mixed
- $_manager : mixed
- $_pagination_params : mixed
- $acquirer : string
- acquirer
- $acquirer_reconciliation : string
- acquirer_reconciliation
- $additional_info : array<string|int, mixed>
- additional_info
- $amount_refunded : float
- amount_refunded
- $application_fee : float
- application_fee
- $authorization_code : string
- authorization_code
- $barcode : string
- barcode
- $binary_mode : bool
- binary_mode
- $call_for_authorize_id : string
- call_for_authorize_id
- $callback_url : string
- callback_url
- $campaign_id : string
- campaign_id
- $capture : bool
- capture
- $captured : bool
- captured
- $card : int
- card
- $charges_details : object
- charges details
- $collector : object
- collector
- $collector_id : int
- collector_id
- $corporation_id : string
- corporation_id
- $counter_currency : string
- counter_currency
- $coupon_amount : float
- coupon_amount
- $coupon_code : string
- coupon_code
- $currency_id : string
- currency_id
- $date_approved : DateTime
- date_approved
- $date_created : DateTime
- date_created
- $date_last_updated : DateTime
- date_last_update
- $date_of_expiration : DateTime
- date_of_expiration
- $deduction_schema : string
- deduction_schema
- $description : string
- description
- $differential_pricing_id : int
- differential_pricing_id
- $error : mixed
- $external_reference : string
- external_reference
- $fee_details : object
- fee_details
- $finance_charge : float
- finance_charge
- $id : int
- id
- $installments : int
- installments
- $integrator_id : string
- integrator_id
- $issuer_id : string
- issuer_id
- $last_modified : DateTime
- last_modified
- $live_mode : bool
- live_mode
- $marketplace : string
- marketplace
- $marketplace_fee : float
- marketplace_fee
- $marketplace_owner : int
- marketplace_owner
- $merchant_account_id : int
- merchant_account_id
- $merchant_number : int
- merchant_number
- $metadata : object
- metadata
- $money_release_date : DateTime
- money_release_date
- $money_release_schema : string
- money_release_schema
- $net_amount : float
- net_amount
- $net_received_amount : float
- net_received_amount
- $notification_url : string
- notification_url
- $operation_type : string
- operation_type
- $order : int
- order
- $order_id : int
- order_id
- $payer : object
- payer
- $payment_method_id : string
- payment_method_id
- $payment_type : string
- payment_type
- $payment_type_id : string
- payment_type_id
- $platform_id : string
- platform_id
- $pos_id : string
- pos_id
- $processing_mode : string
- processing_mode
- $reason : string
- reason
- $refunds : object
- refunds
- $shipping_amount : float
- Shipping_amount
- $shipping_cost : float
- shipping_cost
- $site_id : string
- site_id
- $sponsor_id : int
- sponsor_id
- $statement_descriptor : string
- statement_descriptor
- $status : string
- status
- $status_detail : string
- status_detail
- $store_id : int
- store_id
- $taxes : array<string|int, mixed>
- taxes
- $taxes_amount : float
- taxes_amount
- $token : string
- token
- $total_paid_amount : float
- total_paid_amount
- $transaction_amount : float
- transaction_amount
- $transaction_amount_refunded : float
- transaction_amount_refunded
- $transaction_details : object
- transaction_details
- __construct() : mixed
- Entity constructor.
- __get() : mixed
- __isset() : bool
- __set() : mixed
- all() : mixed
- APCIteratorAll() : mixed
- capture() : Payment
- capture
- custom_action() : mixed
- delete() : mixed
- destroy() : mixed
- Error() : mixed
- find_by_id() : mixed
- get() : mixed
- getAttributes() : array<string|int, mixed>
- getCustomHeader() : mixed
- getCustomHeaders() : mixed
- not_found() : mixed
- process_error_body() : mixed
- read() : mixed
- refund() : bool
- refund
- save() : mixed
- search() : mixed
- setCustomHeader() : mixed
- setCustomHeadersFromArray() : mixed
- setManager() : mixed
- toArray() : array<string|int, mixed>
- unSetManager() : mixed
- update() : mixed
- _camelize() : mixed
- _fillFromArray() : mixed
- Fill entity from data with nested object creation
- _getDynamicAttributeDenied() : mixed
- _getPropertyType() : mixed
- _propertyExists() : bool
- _propertyTypeAllowed() : bool
- _setValue() : mixed
- tryFormat() : array<string|int, mixed>|bool|float|int|string
Properties
$_custom_headers
protected
static mixed
$_custom_headers
= array()
$_empty
protected
mixed
$_empty
= false
Tags
$_last
protected
mixed
$_last
Tags
$_manager
protected
static mixed
$_manager
$_pagination_params
protected
mixed
$_pagination_params
$acquirer
acquirer
protected
string
$acquirer
Tags
$acquirer_reconciliation
acquirer_reconciliation
protected
string
$acquirer_reconciliation
Tags
$additional_info
additional_info
protected
array<string|int, mixed>
$additional_info
Tags
$amount_refunded
amount_refunded
protected
float
$amount_refunded
Tags
$application_fee
application_fee
protected
float
$application_fee
Tags
$authorization_code
authorization_code
protected
string
$authorization_code
Tags
$barcode
barcode
protected
string
$barcode
Tags
$binary_mode
binary_mode
protected
bool
$binary_mode
Tags
$call_for_authorize_id
call_for_authorize_id
protected
string
$call_for_authorize_id
Tags
$callback_url
callback_url
protected
string
$callback_url
Tags
$campaign_id
campaign_id
protected
string
$campaign_id
Tags
$capture
capture
protected
bool
$capture
Tags
$captured
captured
protected
bool
$captured
Tags
$card
card
protected
int
$card
Tags
$charges_details
charges details
protected
object
$charges_details
Tags
$collector
collector
protected
object
$collector
Tags
$collector_id
collector_id
protected
int
$collector_id
Tags
$corporation_id
corporation_id
protected
string
$corporation_id
Tags
$counter_currency
counter_currency
protected
string
$counter_currency
Tags
$coupon_amount
coupon_amount
protected
float
$coupon_amount
Tags
$coupon_code
coupon_code
protected
string
$coupon_code
Tags
$currency_id
currency_id
protected
string
$currency_id
Tags
$date_approved
date_approved
protected
DateTime
$date_approved
Tags
$date_created
date_created
protected
DateTime
$date_created
Tags
$date_last_updated
date_last_update
protected
DateTime
$date_last_updated
Tags
$date_of_expiration
date_of_expiration
protected
DateTime
$date_of_expiration
Tags
$deduction_schema
deduction_schema
protected
string
$deduction_schema
Tags
$description
description
protected
string
$description
Tags
$differential_pricing_id
differential_pricing_id
protected
int
$differential_pricing_id
Tags
$error
protected
mixed
$error
$external_reference
external_reference
protected
string
$external_reference
Tags
$fee_details
fee_details
protected
object
$fee_details
Tags
$finance_charge
finance_charge
protected
float
$finance_charge
Tags
$id
id
protected
int
$id
Tags
$installments
installments
protected
int
$installments
Tags
$integrator_id
integrator_id
protected
string
$integrator_id
Tags
$issuer_id
issuer_id
protected
string
$issuer_id
Tags
$last_modified
last_modified
protected
DateTime
$last_modified
Tags
$live_mode
live_mode
protected
bool
$live_mode
Tags
$marketplace
marketplace
protected
string
$marketplace
Tags
$marketplace_fee
marketplace_fee
protected
float
$marketplace_fee
Tags
$marketplace_owner
marketplace_owner
protected
int
$marketplace_owner
Tags
$merchant_account_id
merchant_account_id
protected
int
$merchant_account_id
Tags
$merchant_number
merchant_number
protected
int
$merchant_number
Tags
$metadata
metadata
protected
object
$metadata
Tags
$money_release_date
money_release_date
protected
DateTime
$money_release_date
Tags
$money_release_schema
money_release_schema
protected
string
$money_release_schema
Tags
$net_amount
net_amount
protected
float
$net_amount
Tags
$net_received_amount
net_received_amount
protected
float
$net_received_amount
Tags
$notification_url
notification_url
protected
string
$notification_url
Tags
$operation_type
operation_type
protected
string
$operation_type
Tags
$order
order
protected
int
$order
Tags
$order_id
order_id
protected
int
$order_id
Tags
$payer
payer
protected
object
$payer
Tags
$payment_method_id
payment_method_id
protected
string
$payment_method_id
Tags
$payment_type
payment_type
protected
string
$payment_type
Tags
$payment_type_id
payment_type_id
protected
string
$payment_type_id
Tags
$platform_id
platform_id
protected
string
$platform_id
Tags
$pos_id
pos_id
protected
string
$pos_id
Tags
$processing_mode
processing_mode
protected
string
$processing_mode
Tags
$reason
reason
protected
string
$reason
Tags
$refunds
refunds
protected
object
$refunds
Tags
$shipping_amount
Shipping_amount
protected
float
$shipping_amount
Tags
$shipping_cost
shipping_cost
protected
float
$shipping_cost
Tags
$site_id
site_id
protected
string
$site_id
Tags
$sponsor_id
sponsor_id
protected
int
$sponsor_id
Tags
$statement_descriptor
statement_descriptor
protected
string
$statement_descriptor
Tags
$status
status
protected
string
$status
Tags
$status_detail
status_detail
protected
string
$status_detail
Tags
$store_id
store_id
protected
int
$store_id
Tags
$taxes
taxes
protected
array<string|int, mixed>
$taxes
Tags
$taxes_amount
taxes_amount
protected
float
$taxes_amount
Tags
$token
token
protected
string
$token
Tags
$total_paid_amount
total_paid_amount
protected
float
$total_paid_amount
Tags
$transaction_amount
transaction_amount
protected
float
$transaction_amount
Tags
$transaction_amount_refunded
transaction_amount_refunded
protected
float
$transaction_amount_refunded
Tags
$transaction_details
transaction_details
protected
object
$transaction_details
Tags
Methods
__construct()
Entity constructor.
public
__construct([array<string|int, mixed> $params = [] ]) : mixed
Parameters
- $params : array<string|int, mixed> = []
Tags
Return values
mixed —__get()
public
__get( $name) : mixed
Parameters
Return values
mixed —__isset()
public
__isset( $name) : bool
Parameters
Return values
bool —__set()
public
__set( $name, $value) : mixed
Parameters
Tags
Return values
mixed —all()
public
static all([mixed $options = [] ]) : mixed
Parameters
- $options : mixed = []
Return values
mixed —APCIteratorAll()
public
APCIteratorAll() : mixed
Tags
Return values
mixed —capture()
capture
public
capture(int $amount) : Payment
Parameters
- $amount : int
Tags
Return values
Payment —custom_action()
public
custom_action(mixed $method, mixed $action) : mixed
Parameters
- $method : mixed
- $action : mixed
Return values
mixed —delete()
public
delete([mixed $options = [] ]) : mixed
Parameters
- $options : mixed = []
Return values
mixed —destroy()
public
static destroy() : mixed
Tags
Return values
mixed —Error()
public
Error() : mixed
Return values
mixed —find_by_id()
public
static find_by_id(mixed $id) : mixed
Parameters
- $id : mixed
Return values
mixed —get()
public
static get(mixed $id) : mixed
Parameters
- $id : mixed
Return values
mixed —getAttributes()
public
getAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCustomHeader()
public
static getCustomHeader(mixed $key) : mixed
Parameters
- $key : mixed
Return values
mixed —getCustomHeaders()
public
static getCustomHeaders() : mixed
Return values
mixed —not_found()
public
not_found() : mixed
Return values
mixed —process_error_body()
public
process_error_body(mixed $message) : mixed
Parameters
- $message : mixed
Return values
mixed —read()
public
static read([mixed $params = [] ][, mixed $options = [] ]) : mixed
Parameters
- $params : mixed = []
- $options : mixed = []
Return values
mixed —refund()
refund
public
refund(int $amount) : bool
Parameters
- $amount : int
Tags
Return values
bool —save()
public
save([mixed $options = [] ]) : mixed
Parameters
- $options : mixed = []
Return values
mixed —search()
public
static search([mixed $filters = [] ][, mixed $options = [] ]) : mixed
Parameters
- $filters : mixed = []
- $options : mixed = []
Return values
mixed —setCustomHeader()
public
static setCustomHeader(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
- $value : mixed
Return values
mixed —setCustomHeadersFromArray()
public
static setCustomHeadersFromArray(mixed $array) : mixed
Parameters
- $array : mixed
Return values
mixed —setManager()
public
static setManager(Manager $manager) : mixed
Parameters
- $manager : Manager
Return values
mixed —toArray()
public
toArray([null $attributes = null ]) : array<string|int, mixed>
Parameters
- $attributes : null = null
Return values
array<string|int, mixed> —unSetManager()
public
static unSetManager() : mixed
Return values
mixed —update()
public
update([mixed $options = [] ]) : mixed
Parameters
- $options : mixed = []
Return values
mixed —_camelize()
protected
_camelize( $input[, string $separator = '_' ]) : mixed
Parameters
Return values
mixed —_fillFromArray()
Fill entity from data with nested object creation
protected
_fillFromArray( $entity, $data) : mixed
Parameters
Return values
mixed —_getDynamicAttributeDenied()
protected
_getDynamicAttributeDenied() : mixed
Return values
mixed —_getPropertyType()
protected
_getPropertyType( $property) : mixed
Parameters
Return values
mixed —_propertyExists()
protected
_propertyExists( $property) : bool
Parameters
Return values
bool —_propertyTypeAllowed()
protected
_propertyTypeAllowed( $property, $type) : bool
Parameters
Return values
bool —_setValue()
protected
_setValue( $property, $value[, mixed $validate = true ]) : mixed
Parameters
Tags
Return values
mixed —tryFormat()
protected
tryFormat( $value, $type, $property) : array<string|int, mixed>|bool|float|int|string