Documentation

PaymentSetupResponse
in package
implements ModelInterface, ArrayAccess

Warning:

This class subject to change without prior notice, Please dont use this class directly.

Tags
category

Class

Interfaces, Classes and Traits

ModelInterface
Warning:
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
PAYMENT_METHOD_ACH  = 'ach'
PAYMENT_METHOD_AMEX_CREDIT  = 'amex_credit'
PAYMENT_METHOD_DISCOVER_CREDIT  = 'discover_credit'
PAYMENT_METHOD_DISCOVER_DEBIT  = 'discover_debit'
PAYMENT_METHOD_MASTER_CREDIT  = 'master_credit'
PAYMENT_METHOD_MASTER_DEBIT  = 'master_debit'
PAYMENT_METHOD_PINLESS_DEBIT  = 'pinless_debit'
PAYMENT_METHOD_VISA_CREDIT  = 'visa_credit'
PAYMENT_METHOD_VISA_DEBIT  = 'visa_debit'
PAYMENT_SETUP_SCHEDULE_TYPE_AUTOPAY_ENROLLMENT  = 'autopay_enrollment'
PAYMENT_SETUP_SCHEDULE_TYPE_PAYMENT_PLAN  = 'payment_plan'
PAYMENT_SETUP_SCHEDULE_TYPE_VARIABLE_RECURRING_ENROLLMENT  = 'variable_recurring_enrollment'
STATUS_CANCELLED  = 'cancelled'
STATUS_COMPLETED  = 'completed'
STATUS_DECLINED  = 'declined'
STATUS_ERROR  = 'error'
STATUS_SCHEDULED  = 'scheduled'
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$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
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
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
getAmount()  : string
Gets amount
getAuditInfo()  : AuditInfoVo
Gets audit_info
getCardCvvNumber()  : string
Gets card_cvv_number
getComments()  : string
Gets comments
getConfirmationNumber()  : string
Gets confirmation_number
getCurrencyCode3d()  : string
Gets currency_code3d
getCustomer()  : CustomerSnapshotResponse
Gets customer
getCustomerAccount()  : CustomerAccountSnapshotResponse
Gets customer_account
getCustomFields()  : mixed
Gets custom_fields
getFee()  : FeeResponse
Gets fee
getFundingAccount()  : FundingAccountSnapshotResponse
Gets funding_account
getId()  : string
Gets id
getModelName()  : string
The original name of the model.
getNextPaymentDate()  : string
Gets next_payment_date
getPaymentMethod()  : string
Gets payment_method
getPaymentMethodAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getPaymentNetworkResponse()  : PaymentNetworkResponseVo
Gets payment_network_response
getPaymentSchedule()  : PaymentScheduleVo
Gets payment_schedule
getPaymentSetupEntryDate()  : string
Gets payment_setup_entry_date
getPaymentSetupReference()  : string
Gets payment_setup_reference
getPaymentSetupScheduleType()  : string
Gets payment_setup_schedule_type
getPaymentSetupScheduleTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getStatus()  : string
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrl()  : string
Gets url
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAmount()  : $this
Sets amount
setAuditInfo()  : $this
Sets audit_info
setCardCvvNumber()  : $this
Sets card_cvv_number
setComments()  : $this
Sets comments
setConfirmationNumber()  : $this
Sets confirmation_number
setCurrencyCode3d()  : $this
Sets currency_code3d
setCustomer()  : $this
Sets customer
setCustomerAccount()  : $this
Sets customer_account
setCustomFields()  : $this
Sets custom_fields
setFee()  : $this
Sets fee
setFundingAccount()  : $this
Sets funding_account
setId()  : $this
Sets id
setNextPaymentDate()  : $this
Sets next_payment_date
setPaymentMethod()  : $this
Sets payment_method
setPaymentNetworkResponse()  : $this
Sets payment_network_response
setPaymentSchedule()  : $this
Sets payment_schedule
setPaymentSetupEntryDate()  : $this
Sets payment_setup_entry_date
setPaymentSetupReference()  : $this
Sets payment_setup_reference
setPaymentSetupScheduleType()  : $this
Sets payment_setup_schedule_type
setStatus()  : $this
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUrl()  : $this
Sets url
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

Constants

PAYMENT_METHOD_DISCOVER_CREDIT

public mixed PAYMENT_METHOD_DISCOVER_CREDIT = 'discover_credit'

PAYMENT_METHOD_DISCOVER_DEBIT

public mixed PAYMENT_METHOD_DISCOVER_DEBIT = 'discover_debit'

PAYMENT_METHOD_MASTER_CREDIT

public mixed PAYMENT_METHOD_MASTER_CREDIT = 'master_credit'

PAYMENT_METHOD_PINLESS_DEBIT

public mixed PAYMENT_METHOD_PINLESS_DEBIT = 'pinless_debit'

PAYMENT_SETUP_SCHEDULE_TYPE_AUTOPAY_ENROLLMENT

public mixed PAYMENT_SETUP_SCHEDULE_TYPE_AUTOPAY_ENROLLMENT = 'autopay_enrollment'

PAYMENT_SETUP_SCHEDULE_TYPE_PAYMENT_PLAN

public mixed PAYMENT_SETUP_SCHEDULE_TYPE_PAYMENT_PLAN = 'payment_plan'

PAYMENT_SETUP_SCHEDULE_TYPE_VARIABLE_RECURRING_ENROLLMENT

public mixed PAYMENT_SETUP_SCHEDULE_TYPE_VARIABLE_RECURRING_ENROLLMENT = 'variable_recurring_enrollment'

Properties

$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', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', 'payment_network_response' => 'payment_network_response', 'audit_info' => 'audit_info']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$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', 'customer' => 'getCustomer', 'funding_account' => 'getFundingAccount', 'customer_account' => 'getCustomerAccount', 'payment_network_response' => 'getPaymentNetworkResponse', 'audit_info' => 'getAuditInfo']

$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', 'customer' => 'setCustomer', 'funding_account' => 'setFundingAccount', 'customer_account' => 'setCustomerAccount', 'payment_network_response' => 'setPaymentNetworkResponse', 'audit_info' => 'setAuditInfo']

$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, 'customer' => null, 'funding_account' => null, 'customer_account' => null, 'payment_network_response' => null, 'audit_info' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'PaymentSetupResponse'

$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\Model\FeeResponse', '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\Model\PaymentScheduleVo', 'payment_setup_entry_date' => 'string', 'comments' => 'string', 'customer' => '\Orbipay\PaymentsApi\Client\Model\CustomerSnapshotResponse', 'funding_account' => '\Orbipay\PaymentsApi\Client\Model\FundingAccountSnapshotResponse', 'customer_account' => '\Orbipay\PaymentsApi\Client\Model\CustomerAccountSnapshotResponse', 'payment_network_response' => '\Orbipay\PaymentsApi\Client\Model\PaymentNetworkResponseVo', 'audit_info' => '\Orbipay\PaymentsApi\Client\Model\AuditInfoVo']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

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> —

getCardCvvNumber()

Gets card_cvv_number

public getCardCvvNumber() : string
Return values
string —

getConfirmationNumber()

Gets confirmation_number

public getConfirmationNumber() : string
Return values
string —

getCurrencyCode3d()

Gets currency_code3d

public getCurrencyCode3d() : string
Return values
string —

getCustomFields()

Gets custom_fields

public getCustomFields() : mixed
Return values
mixed —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getNextPaymentDate()

Gets next_payment_date

public getNextPaymentDate() : string
Return values
string —

getPaymentMethod()

Gets payment_method

public getPaymentMethod() : string
Return values
string —

getPaymentMethodAllowableValues()

Gets allowable values of the enum

public getPaymentMethodAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getPaymentSetupEntryDate()

Gets payment_setup_entry_date

public getPaymentSetupEntryDate() : string
Return values
string —

getPaymentSetupReference()

Gets payment_setup_reference

public getPaymentSetupReference() : string
Return values
string —

getPaymentSetupScheduleType()

Gets payment_setup_schedule_type

public getPaymentSetupScheduleType() : string
Return values
string —

getPaymentSetupScheduleTypeAllowableValues()

Gets allowable values of the enum

public getPaymentSetupScheduleTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getStatusAllowableValues()

Gets allowable values of the enum

public getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getters()

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

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

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

setAmount()

Sets amount

public setAmount(string $amount) : $this
Parameters
$amount : string

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.

Return values
$this —

setCardCvvNumber()

Sets card_cvv_number

public setCardCvvNumber(string $card_cvv_number) : $this
Parameters
$card_cvv_number : string

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

Return values
$this —

setComments()

Sets comments

public setComments(string $comments) : $this
Parameters
$comments : string

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.

Return values
$this —

setConfirmationNumber()

Sets confirmation_number

public setConfirmationNumber(string $confirmation_number) : $this
Parameters
$confirmation_number : string

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

Return values
$this —

setCurrencyCode3d()

Sets currency_code3d

public setCurrencyCode3d(string $currency_code3d) : $this
Parameters
$currency_code3d : string

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

Return values
$this —

setCustomFields()

Sets custom_fields

public setCustomFields(mixed $custom_fields) : $this
Parameters
$custom_fields : mixed
Return values
$this —

setId()

Sets id

public setId(string $id) : $this
Parameters
$id : string

The unique identifier assigned by EBPP to the payment setup.

Return values
$this —

setNextPaymentDate()

Sets next_payment_date

public setNextPaymentDate(string $next_payment_date) : $this
Parameters
$next_payment_date : string

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

Return values
$this —

setPaymentMethod()

Sets payment_method

public setPaymentMethod(string $payment_method) : $this
Parameters
$payment_method : string

The fulfillment method for the payment.

Return values
$this —

setPaymentSetupEntryDate()

Sets payment_setup_entry_date

public setPaymentSetupEntryDate(string $payment_setup_entry_date) : $this
Parameters
$payment_setup_entry_date : string

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

Return values
$this —

setPaymentSetupReference()

Sets payment_setup_reference

public setPaymentSetupReference(string $payment_setup_reference) : $this
Parameters
$payment_setup_reference : string

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

Return values
$this —

setPaymentSetupScheduleType()

Sets payment_setup_schedule_type

public setPaymentSetupScheduleType(string $payment_setup_schedule_type) : $this
Parameters
$payment_setup_schedule_type : string

The schedule type for the payment setup.

Return values
$this —

setStatus()

Sets status

public setStatus(string $status) : $this
Parameters
$status : string

The status of the payment.

Return values
$this —

setters()

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

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

setUrl()

Sets url

public setUrl(string $url) : $this
Parameters
$url : string

This URL fetches the details of payment setup.

Return values
$this —

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> —

Search results