Documentation

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
link

Click here for more infos

RestMethod

(resource="/v1/payments", method="create")

RestMethod

(resource="/v1/payments/:id", method="read")

RestMethod

(resource="/v1/payments/search", method="search")

RestMethod

(resource="/v1/payments/:id", method="update")

RestMethod

(resource="/v1/payments/:id/refunds", method="refund")

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
Attribute

(serialize = false)

$_last

protected mixed $_last
Tags
Attribute

(serialize = false)

$_manager

protected static mixed $_manager

$_pagination_params

protected mixed $_pagination_params

$acquirer

acquirer

protected string $acquirer
Tags
Attribute

()

$acquirer_reconciliation

acquirer_reconciliation

protected string $acquirer_reconciliation
Tags
Attribute

()

$additional_info

additional_info

protected array<string|int, mixed> $additional_info
Tags
Attribute

()

$amount_refunded

amount_refunded

protected float $amount_refunded
Tags
Attribute

()

$application_fee

application_fee

protected float $application_fee
Tags
Attribute

()

$authorization_code

authorization_code

protected string $authorization_code
Tags
Attribute

()

$barcode

barcode

protected string $barcode
Tags
Attribute

()

$binary_mode

binary_mode

protected bool $binary_mode
Tags
Attribute

()

$call_for_authorize_id

call_for_authorize_id

protected string $call_for_authorize_id
Tags
Attribute

()

$callback_url

callback_url

protected string $callback_url
Tags
Attribute

()

$campaign_id

campaign_id

protected string $campaign_id
Tags
Attribute

()

$capture

capture

protected bool $capture
Tags
Attribute

()

$captured

captured

protected bool $captured
Tags
Attribute

()

$card

card

protected int $card
Tags
Attribute

()

$charges_details

charges details

protected object $charges_details
Tags
Attribute

()

$collector

collector

protected object $collector
Tags
Attribute

()

$collector_id

collector_id

protected int $collector_id
Tags
Attribute

()

$corporation_id

corporation_id

protected string $corporation_id
Tags
Attribute

()

$counter_currency

counter_currency

protected string $counter_currency
Tags
Attribute

()

$coupon_amount

coupon_amount

protected float $coupon_amount
Tags
Attribute

()

$coupon_code

coupon_code

protected string $coupon_code
Tags
Attribute

()

$currency_id

currency_id

protected string $currency_id
Tags
Attribute

()

$date_approved

date_approved

protected DateTime $date_approved
Tags
Attribute

()

$date_created

date_created

protected DateTime $date_created
Tags
Attribute

()

$date_last_updated

date_last_update

protected DateTime $date_last_updated
Tags
Attribute

()

$date_of_expiration

date_of_expiration

protected DateTime $date_of_expiration
Tags
Attribute

()

$deduction_schema

deduction_schema

protected string $deduction_schema
Tags
Attribute

()

$description

description

protected string $description
Tags
Attribute

()

$differential_pricing_id

differential_pricing_id

protected int $differential_pricing_id
Tags
Attribute

()

$external_reference

external_reference

protected string $external_reference
Tags
Attribute

()

$fee_details

fee_details

protected object $fee_details
Tags
Attribute

()

$finance_charge

finance_charge

protected float $finance_charge
Tags
Attribute

(type = "float")

$id

id

protected int $id
Tags
Attribute

(primaryKey = true)

$installments

installments

protected int $installments
Tags
Attribute

(type = "int")

$integrator_id

integrator_id

protected string $integrator_id
Tags
Attribute

()

$issuer_id

issuer_id

protected string $issuer_id
Tags
Attribute

()

$last_modified

last_modified

protected DateTime $last_modified
Tags
Attribute

()

$live_mode

live_mode

protected bool $live_mode
Tags
Attribute

()

$marketplace

marketplace

protected string $marketplace
Tags
Attribute

()

$marketplace_fee

marketplace_fee

protected float $marketplace_fee
Tags
Attribute

(type = "float")

$marketplace_owner

marketplace_owner

protected int $marketplace_owner
Tags
Attribute

()

$merchant_account_id

merchant_account_id

protected int $merchant_account_id
Tags
Attribute

()

$merchant_number

merchant_number

protected int $merchant_number
Tags
Attribute

()

$metadata

metadata

protected object $metadata
Tags
Attribute

()

$money_release_date

money_release_date

protected DateTime $money_release_date
Tags
Attribute

()

$money_release_schema

money_release_schema

protected string $money_release_schema
Tags
Attribute

()

$net_amount

net_amount

protected float $net_amount
Tags
Attribute

(type = "float")

$net_received_amount

net_received_amount

protected float $net_received_amount
Tags
Attribute

()

$notification_url

notification_url

protected string $notification_url
Tags
Attribute

()

$operation_type

operation_type

protected string $operation_type
Tags
Attribute

()

$order

order

protected int $order
Tags
Attribute

()

$order_id

order_id

protected int $order_id
Tags
Attribute

(idempotency = true)

$payer

payer

protected object $payer
Tags
Attribute

()

$payment_method_id

payment_method_id

protected string $payment_method_id
Tags
Attribute

()

$payment_type

payment_type

protected string $payment_type
Tags
Attribute

(type = "string")

$payment_type_id

payment_type_id

protected string $payment_type_id
Tags
Attribute

()

$platform_id

platform_id

protected string $platform_id
Tags
Attribute

()

$pos_id

pos_id

protected string $pos_id
Tags
Attribute

()

$processing_mode

processing_mode

protected string $processing_mode
Tags
Attribute

()

$reason

reason

protected string $reason
Tags
Attribute

()

$refunds

refunds

protected object $refunds
Tags
Attribute

()

$shipping_amount

Shipping_amount

protected float $shipping_amount
Tags
Attribute

()

$shipping_cost

shipping_cost

protected float $shipping_cost
Tags
Attribute

()

$site_id

site_id

protected string $site_id
Tags
Attribute

(idempotency = true)

$sponsor_id

sponsor_id

protected int $sponsor_id
Tags
Attribute

()

$statement_descriptor

statement_descriptor

protected string $statement_descriptor
Tags
Attribute

()

$status

status

protected string $status
Tags
Attribute

()

$status_detail

status_detail

protected string $status_detail
Tags
Attribute

()

$store_id

store_id

protected int $store_id
Tags
Attribute

()

$taxes

taxes

protected array<string|int, mixed> $taxes
Tags
Attribute

(type = "array")

$taxes_amount

taxes_amount

protected float $taxes_amount
Tags
Attribute

()

$token

token

protected string $token
Tags
Attribute

()

$total_paid_amount

total_paid_amount

protected float $total_paid_amount
Tags
Attribute

(idempotency = true)

$transaction_amount

transaction_amount

protected float $transaction_amount
Tags
Attribute

(type = "float")

$transaction_amount_refunded

transaction_amount_refunded

protected float $transaction_amount_refunded
Tags
Attribute

(type = "float")

$transaction_details

transaction_details

protected object $transaction_details
Tags
Attribute

()

Methods

__construct()

Entity constructor.

public __construct([array<string|int, mixed> $params = [] ]) : mixed
Parameters
$params : array<string|int, mixed> = []
Tags
throws
Exception
Return values
mixed

__get()

public __get( $name) : mixed
Parameters
$name :
Return values
mixed

__isset()

public __isset( $name) : bool
Parameters
$name :
Return values
bool

__set()

public __set( $name,  $value) : mixed
Parameters
$name :
$value :
Tags
throws
Exception
Return values
mixed

all()

public static all([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed

APCIteratorAll()

public APCIteratorAll() : mixed
Tags
codeCoverageIgnore
Return values
mixed

capture()

capture

public capture(int $amount) : Payment
Parameters
$amount : int
Tags
throws
Exception
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
codeCoverageIgnore
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
throws
Exception
Return values
bool

save()

public save([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed
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
$input :
$separator : string = '_'
Return values
mixed

_fillFromArray()

Fill entity from data with nested object creation

protected _fillFromArray( $entity,  $data) : mixed
Parameters
$entity :
$data :
Return values
mixed

_getDynamicAttributeDenied()

protected _getDynamicAttributeDenied() : mixed
Return values
mixed

_getPropertyType()

protected _getPropertyType( $property) : mixed
Parameters
$property :
Return values
mixed

_propertyExists()

protected _propertyExists( $property) : bool
Parameters
$property :
Return values
bool

_propertyTypeAllowed()

protected _propertyTypeAllowed( $property,  $type) : bool
Parameters
$property :
$type :
Return values
bool

_setValue()

protected _setValue( $property,  $value[, mixed $validate = true ]) : mixed
Parameters
$property :
$value :
$validate : mixed = true
Tags
throws
Exception
Return values
mixed

tryFormat()

protected tryFormat( $value,  $type,  $property) : array<string|int, mixed>|bool|float|int|string
Parameters
$value :
$type :
$property :
Tags
throws
Exception
Return values
array<string|int, mixed>|bool|float|int|string

Search results