Documentation

PaymentSetup extends Base
in package

PaymentSetup Class Doc Comment

Tags
category

Class

Table of Contents

DISCRIMINATOR  = null
$api_end_point  : string
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$amount  : string
$audit_info  : AuditInfo
$card_cvv_number  : string
$comments  : string
$confirmation_number  : string
$currency_code3d  : string
$custom_fields  : mixed
$customer  : Customer
$customer_account  : CustomerAccount
$deleted  : string
$fee  : Fee
$funding_account  : FundingAccount
$http_status_code  : mixed
$id  : string
$id_customer  : string
$id_payment_setup  : string
$invocation_context  : InvocationContext
$live_mode  : string
$next_payment_date  : string
$payment_method  : string
$payment_network_response  : PaymentNetworkResponse
$payment_schedule  : PaymentSchedule
$payment_setup_entry_date  : string
$payment_setup_reference  : string
$payment_setup_schedule_type  : string
$status  : string
$url  : string
__construct()  : mixed
PaymentSetup constructor.
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
create()  : PaymentSetup
create
createdBy()  : PaymentSetup
createdBy
delete()  : PaymentSetup
delete
deletedBy()  : PaymentSetup
deletedBy
forClient()  : mixed
forCustomer()  : mixed
fromAccount()  : mixed
get()  : PaymentSetup
get
getAmount()  : string
Gets amount
getApiEndPoint()  : string
getAuditInfo()  : AuditInfo
Gets audit_info
getCardCvvNumber()  : string
Gets card_cvv_number
getComments()  : string
Gets comments
getConfirmationNumber()  : string
Gets confirmation_number
getCurrencyCode3d()  : string
Gets currency_code3d
getCustomer()  : Customer
Gets customer
getCustomerAccount()  : CustomerAccount
Gets customer_account
getCustomFields()  : mixed
Gets custom_fields
getDeleted()  : string
Gets deleted
getFee()  : Fee
Gets fee
getFundingAccount()  : FundingAccount
Gets funding_account
getHttpStatusCode()  : mixed
getId()  : string
Gets id
getIdCustomer()  : string
Gets id_customer
getIdPaymentSetup()  : string
Gets id_payment_setup
getInvocationContext()  : InvocationContext
getNextPaymentDate()  : string
Gets next_payment_date
getPaymentMethod()  : string
Gets payment_method
getPaymentNetworkResponse()  : PaymentNetworkResponse
Gets payment_network_response
getPaymentSchedule()  : PaymentSchedule
Gets payment_schedule
getPaymentSetupEntryDate()  : string
Gets payment_setup_entry_date
getPaymentSetupReference()  : string
Gets payment_setup_reference
getPaymentSetupScheduleType()  : string
Gets payment_setup_schedule_type
getStatus()  : string
Gets status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrl()  : string
Gets url
jsonSerialize()  : mixed
Specify data which should be serialized to JSON
retrievedBy()  : PaymentSetup
retrievedBy
setInvocationContext()  : mixed
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
toAccount()  : mixed
update()  : PaymentSetup
update
updatedBy()  : PaymentSetup
updatedBy
videChannel()  : mixed
withContext()  : mixed
withCustomFields()  : mixed
withDetails()  : mixed
withFee()  : mixed
withMemo()  : mixed
withPaymentSchedule()  : mixed
withReference()  : mixed
withStatus()  : mixed
requestedBy()  : mixed
setAPIEndpoint()  : mixed

Constants

Properties

$api_end_point

protected string $api_end_point

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['id' => 'id', 'url' => 'url', 'fee' => 'fee', 'status' => 'status', 'payment_method' => 'payment_method', 'payment_setup_schedule_type' => 'payment_setup_schedule_type', 'confirmation_number' => 'confirmation_number', 'custom_fields' => 'custom_fields', 'currency_code3d' => 'currency_code3d', 'amount' => 'amount', 'card_cvv_number' => 'card_cvv_number', 'next_payment_date' => 'next_payment_date', 'payment_setup_reference' => 'payment_setup_reference', 'payment_schedule' => 'payment_schedule', 'payment_setup_entry_date' => 'payment_setup_entry_date', 'comments' => 'comments', 'deleted' => 'deleted', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', 'payment_network_response' => 'payment_network_response', 'audit_info' => 'audit_info', 'id_customer' => 'ID_CUSTOMER', 'id_payment_setup' => 'ID_PAYMENT_SETUP']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['id' => 'getId', 'url' => 'getUrl', 'fee' => 'getFee', 'status' => 'getStatus', 'payment_method' => 'getPaymentMethod', 'payment_setup_schedule_type' => 'getPaymentSetupScheduleType', 'confirmation_number' => 'getConfirmationNumber', 'custom_fields' => 'getCustomFields', 'currency_code3d' => 'getCurrencyCode3d', 'amount' => 'getAmount', 'card_cvv_number' => 'getCardCvvNumber', 'next_payment_date' => 'getNextPaymentDate', 'payment_setup_reference' => 'getPaymentSetupReference', 'payment_schedule' => 'getPaymentSchedule', 'payment_setup_entry_date' => 'getPaymentSetupEntryDate', 'comments' => 'getComments', 'deleted' => 'getDeleted', 'customer' => 'getCustomer', 'funding_account' => 'getFundingAccount', 'customer_account' => 'getCustomerAccount', 'payment_network_response' => 'getPaymentNetworkResponse', 'audit_info' => 'getAuditInfo', 'id_customer' => 'getIdCustomer', 'id_payment_setup' => 'getIdPaymentSetup']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['id' => 'setId', 'url' => 'setUrl', 'fee' => 'setFee', 'status' => 'setStatus', 'payment_method' => 'setPaymentMethod', 'payment_setup_schedule_type' => 'setPaymentSetupScheduleType', 'confirmation_number' => 'setConfirmationNumber', 'custom_fields' => 'setCustomFields', 'currency_code3d' => 'setCurrencyCode3d', 'amount' => 'setAmount', 'card_cvv_number' => 'setCardCvvNumber', 'next_payment_date' => 'setNextPaymentDate', 'payment_setup_reference' => 'setPaymentSetupReference', 'payment_schedule' => 'setPaymentSchedule', 'payment_setup_entry_date' => 'setPaymentSetupEntryDate', 'comments' => 'setComments', 'deleted' => 'setDeleted', 'customer' => 'setCustomer', 'funding_account' => 'setFundingAccount', 'customer_account' => 'setCustomerAccount', 'payment_network_response' => 'setPaymentNetworkResponse', 'audit_info' => 'setAuditInfo', 'id_customer' => 'setIdCustomer', 'id_payment_setup' => 'setIdPaymentSetup']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['id' => null, 'url' => null, 'fee' => null, 'status' => null, 'payment_method' => null, 'payment_setup_schedule_type' => null, 'confirmation_number' => null, 'custom_fields' => null, 'currency_code3d' => null, 'amount' => null, 'card_cvv_number' => null, 'next_payment_date' => null, 'payment_setup_reference' => null, 'payment_schedule' => null, 'payment_setup_entry_date' => null, 'comments' => null, 'deleted' => null, 'customer' => null, 'funding_account' => null, 'customer_account' => null, 'payment_network_response' => null, 'audit_info' => null, 'id_customer' => null, 'id_payment_setup' => null]

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['id' => 'string', 'url' => 'string', 'fee' => '\Orbipay\PaymentsApi\Client\Wrappers\Fee', 'status' => 'string', 'payment_method' => 'string', 'payment_setup_schedule_type' => 'string', 'confirmation_number' => 'string', 'custom_fields' => 'map[string,string]', 'currency_code3d' => 'string', 'amount' => 'string', 'card_cvv_number' => 'string', 'next_payment_date' => 'string', 'payment_setup_reference' => 'string', 'payment_schedule' => '\Orbipay\PaymentsApi\Client\Wrappers\PaymentSchedule', 'payment_setup_entry_date' => 'string', 'comments' => 'string', 'deleted' => 'string', 'customer' => '\Orbipay\PaymentsApi\Client\Wrappers\Customer', 'funding_account' => '\Orbipay\PaymentsApi\Client\Wrappers\FundingAccount', 'customer_account' => '\Orbipay\PaymentsApi\Client\Wrappers\CustomerAccount', 'payment_network_response' => '\Orbipay\PaymentsApi\Client\Wrappers\PaymentNetworkResponse', 'audit_info' => '\Orbipay\PaymentsApi\Client\Wrappers\AuditInfo', 'id_customer' => 'string', 'id_payment_setup' => 'string']

$confirmation_number

private string $confirmation_number

$http_status_code

private mixed $http_status_code

$live_mode

private string $live_mode

$payment_setup_entry_date

private string $payment_setup_entry_date

$payment_setup_reference

private string $payment_setup_reference

$payment_setup_schedule_type

private string $payment_setup_schedule_type

Methods

__construct()

PaymentSetup constructor.

public __construct([string $id_payment_setup = null ]) : mixed
Parameters
$id_payment_setup : string = null
Return values
mixed —

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

createdBy()

createdBy

public createdBy([ $requestor = null ][,  $requestor_type = null ]) : PaymentSetup
Parameters
$requestor : = null
$requestor_type : = null
Return values
PaymentSetup —

deletedBy()

deletedBy

public deletedBy([ $requestor = null ][,  $requestor_type = null ]) : PaymentSetup
Parameters
$requestor : = null
$requestor_type : = null
Return values
PaymentSetup —

forClient()

public forClient([mixed $client_key = null ]) : mixed
Parameters
$client_key : mixed = null
Return values
mixed —

forCustomer()

public forCustomer([mixed $id_customer = null ]) : mixed
Parameters
$id_customer : mixed = null
Return values
mixed —

fromAccount()

public fromAccount([mixed $funding_account = null ]) : mixed
Parameters
$funding_account : mixed = null
Return values
mixed —

getAmount()

Gets amount

public getAmount() : string
Return values
string —

$amount The amount being paid. In case the payment_amount_type is 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

getApiEndPoint()

public getApiEndPoint() : string
Return values
string —

getCardCvvNumber()

Gets card_cvv_number

public getCardCvvNumber() : string
Return values
string —

$card_cvv_number This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment setup with a card funding account.

getComments()

Gets comments

public getComments() : string
Return values
string —

$comments Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

getConfirmationNumber()

Gets confirmation_number

public getConfirmationNumber() : string
Return values
string —

$confirmation_number The confirmation number or reference provided to the customer for the payment setup.

getCurrencyCode3d()

Gets currency_code3d

public getCurrencyCode3d() : string
Return values
string —

$currency_code3d The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.

getCustomFields()

Gets custom_fields

public getCustomFields() : mixed
Return values
mixed —

getDeleted()

Gets deleted

public getDeleted() : string
Return values
string —

$deleted The status of payment which says whether the payment is deleted or not

getHttpStatusCode()

public getHttpStatusCode() : mixed
Return values
mixed —

getId()

Gets id

public getId() : string
Return values
string —

$id The unique identifier assigned by Orbipay to the payment setup.

getIdCustomer()

Gets id_customer

public getIdCustomer() : string
Return values
string —

$id_customer The unique identifier assigned by EBPP to the customer.

getIdPaymentSetup()

Gets id_payment_setup

public getIdPaymentSetup() : string
Return values
string —

$id_payment_setup The unique identifier assigned by EBPP to the payment setup.

getNextPaymentDate()

Gets next_payment_date

public getNextPaymentDate() : string
Return values
string —

$next_payment_date The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

getPaymentMethod()

Gets payment_method

public getPaymentMethod() : string
Return values
string —

$payment_method The fulfillment method for the payment.

getPaymentSetupEntryDate()

Gets payment_setup_entry_date

public getPaymentSetupEntryDate() : string
Return values
string —

$payment_setup_entry_date The date on which the payment setup is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

getPaymentSetupReference()

Gets payment_setup_reference

public getPaymentSetupReference() : string
Return values
string —

$payment_setup_reference The unique identifier in the client system for the payment setup.

getPaymentSetupScheduleType()

Gets payment_setup_schedule_type

public getPaymentSetupScheduleType() : string
Return values
string —

$payment_setup_schedule_type The schedule type for the payment setup.

getStatus()

Gets status

public getStatus() : string
Return values
string —

$status The status of the payment.

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getUrl()

Gets url

public getUrl() : string
Return values
string —

$url This URL fetches the details of payment setup.

retrievedBy()

retrievedBy

public retrievedBy([ $requestor = null ][,  $requestor_type = null ]) : PaymentSetup
Parameters
$requestor : = null
$requestor_type : = null
Return values
PaymentSetup —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

toAccount()

public toAccount([mixed $customer_account = null ]) : mixed
Parameters
$customer_account : mixed = null
Return values
mixed —

updatedBy()

updatedBy

public updatedBy([ $requestor = null ][,  $requestor_type = null ]) : PaymentSetup
Parameters
$requestor : = null
$requestor_type : = null
Return values
PaymentSetup —

videChannel()

public videChannel([mixed $channel = null ]) : mixed
Parameters
$channel : mixed = null
Return values
mixed —

withContext()

public withContext(InvocationContext $request[, string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
$request : InvocationContext
$live_mode : string = null
$apiEndPoint : string = null
Return values
mixed —

withCustomFields()

public withCustomFields([mixed $custom_fields = null ]) : mixed
Parameters
$custom_fields : mixed = null
Return values
mixed —

withDetails()

public withDetails([mixed $amount = null ][, mixed $card_cvv_number = null ][, mixed $payment_setup_schedule_type = null ]) : mixed
Parameters
$amount : mixed = null
$card_cvv_number : mixed = null
$payment_setup_schedule_type : mixed = null
Return values
mixed —

withFee()

public withFee([mixed $fee = null ]) : mixed
Parameters
$fee : mixed = null
Return values
mixed —

withMemo()

public withMemo([mixed $comments = null ]) : mixed
Parameters
$comments : mixed = null
Return values
mixed —

withPaymentSchedule()

public withPaymentSchedule([mixed $payment_schedule = null ]) : mixed
Parameters
$payment_schedule : mixed = null
Return values
mixed —

withReference()

public withReference([mixed $payment_setup_reference = null ]) : mixed
Parameters
$payment_setup_reference : mixed = null
Return values
mixed —

withStatus()

public withStatus([mixed $status = null ]) : mixed
Parameters
$status : mixed = null
Return values
mixed —

requestedBy()

protected requestedBy(mixed $requestor, mixed $requestor_type) : mixed
Parameters
$requestor : mixed
$requestor_type : mixed
Return values
mixed —

setAPIEndpoint()

protected setAPIEndpoint([string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
$live_mode : string = null
$apiEndPoint : string = null
Return values
mixed —

Search results