Documentation

PaymentDetails
in package
implements ModelInterface, ArrayAccess

PaymentDetails Class Doc Comment

Tags
category

Class

description

When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$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
getAllowedPaymentMethods()  : array<string|int, ?string>
Gets allowed_payment_methods
getChargeId()  : string|null
Gets charge_id
getCurrencyCode()  : string|null
Gets currency_code
getCurrencyCodeMetadata()  : PropertyMetadata
Gets currency_code_metadata
getCustomerId()  : string|null
Gets customer_id
getCustomMetadata()  : string|null
Gets custom_metadata
getCustomMetadataRequired()  : bool|null
Gets custom_metadata_required
getGatewayAccountId()  : string|null
Gets gateway_account_id
getGatewayAccountIdMetadata()  : PropertyMetadata
Gets gateway_account_id_metadata
getGatewayDisplayName()  : string|null
Gets gateway_display_name
getGatewayName()  : string|null
Gets gateway_name
getLineItems()  : array<string|int, PaymentLineItem>
Gets line_items
getModelName()  : string
The original name of the model.
getPaymentOption()  : string|null
Gets payment_option
getPaymentSourceId()  : string|null
Gets payment_source_id
getSignerValues()  : PaymentSignerValues
Gets signer_values
getStatus()  : string|null
Gets status
getSubGatewayName()  : string|null
Gets sub_gateway_name
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTotal()  : Money
Gets total
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAllowedPaymentMethods()  : $this
Sets allowed_payment_methods
setChargeId()  : $this
Sets charge_id
setCurrencyCode()  : $this
Sets currency_code
setCurrencyCodeMetadata()  : $this
Sets currency_code_metadata
setCustomerId()  : $this
Sets customer_id
setCustomMetadata()  : $this
Sets custom_metadata
setCustomMetadataRequired()  : $this
Sets custom_metadata_required
setGatewayAccountId()  : $this
Sets gateway_account_id
setGatewayAccountIdMetadata()  : $this
Sets gateway_account_id_metadata
setGatewayDisplayName()  : $this
Sets gateway_display_name
setGatewayName()  : $this
Sets gateway_name
setLineItems()  : $this
Sets line_items
setPaymentOption()  : $this
Sets payment_option
setPaymentSourceId()  : $this
Sets payment_source_id
setSignerValues()  : $this
Sets signer_values
setStatus()  : $this
Sets status
setSubGatewayName()  : $this
Sets sub_gateway_name
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTotal()  : $this
Sets total
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
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

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 = ['allowed_payment_methods' => 'allowedPaymentMethods', 'charge_id' => 'chargeId', 'currency_code' => 'currencyCode', 'currency_code_metadata' => 'currencyCodeMetadata', 'customer_id' => 'customerId', 'custom_metadata' => 'customMetadata', 'custom_metadata_required' => 'customMetadataRequired', 'gateway_account_id' => 'gatewayAccountId', 'gateway_account_id_metadata' => 'gatewayAccountIdMetadata', 'gateway_display_name' => 'gatewayDisplayName', 'gateway_name' => 'gatewayName', 'line_items' => 'lineItems', 'payment_option' => 'paymentOption', 'payment_source_id' => 'paymentSourceId', 'signer_values' => 'signerValues', 'status' => 'status', 'sub_gateway_name' => 'subGatewayName', 'total' => 'total']

$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 = ['allowed_payment_methods' => 'getAllowedPaymentMethods', 'charge_id' => 'getChargeId', 'currency_code' => 'getCurrencyCode', 'currency_code_metadata' => 'getCurrencyCodeMetadata', 'customer_id' => 'getCustomerId', 'custom_metadata' => 'getCustomMetadata', 'custom_metadata_required' => 'getCustomMetadataRequired', 'gateway_account_id' => 'getGatewayAccountId', 'gateway_account_id_metadata' => 'getGatewayAccountIdMetadata', 'gateway_display_name' => 'getGatewayDisplayName', 'gateway_name' => 'getGatewayName', 'line_items' => 'getLineItems', 'payment_option' => 'getPaymentOption', 'payment_source_id' => 'getPaymentSourceId', 'signer_values' => 'getSignerValues', 'status' => 'getStatus', 'sub_gateway_name' => 'getSubGatewayName', 'total' => 'getTotal']

$setters

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

protected static array<string|int, string> $setters = ['allowed_payment_methods' => 'setAllowedPaymentMethods', 'charge_id' => 'setChargeId', 'currency_code' => 'setCurrencyCode', 'currency_code_metadata' => 'setCurrencyCodeMetadata', 'customer_id' => 'setCustomerId', 'custom_metadata' => 'setCustomMetadata', 'custom_metadata_required' => 'setCustomMetadataRequired', 'gateway_account_id' => 'setGatewayAccountId', 'gateway_account_id_metadata' => 'setGatewayAccountIdMetadata', 'gateway_display_name' => 'setGatewayDisplayName', 'gateway_name' => 'setGatewayName', 'line_items' => 'setLineItems', 'payment_option' => 'setPaymentOption', 'payment_source_id' => 'setPaymentSourceId', 'signer_values' => 'setSignerValues', 'status' => 'setStatus', 'sub_gateway_name' => 'setSubGatewayName', 'total' => 'setTotal']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['allowed_payment_methods' => null, 'charge_id' => null, 'currency_code' => null, 'currency_code_metadata' => null, 'customer_id' => null, 'custom_metadata' => null, 'custom_metadata_required' => null, 'gateway_account_id' => null, 'gateway_account_id_metadata' => null, 'gateway_display_name' => null, 'gateway_name' => null, 'line_items' => null, 'payment_option' => null, 'payment_source_id' => null, 'signer_values' => null, 'status' => null, 'sub_gateway_name' => null, 'total' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'paymentDetails'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['allowed_payment_methods' => '?string[]', 'charge_id' => '?string', 'currency_code' => '?string', 'currency_code_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'customer_id' => '?string', 'custom_metadata' => '?string', 'custom_metadata_required' => '?bool', 'gateway_account_id' => '?string', 'gateway_account_id_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'gateway_display_name' => '?string', 'gateway_name' => '?string', 'line_items' => '\\DocuSign\\eSign\\Model\\PaymentLineItem[]', 'payment_option' => '?string', 'payment_source_id' => '?string', 'signer_values' => '\\DocuSign\\eSign\\Model\\PaymentSignerValues', 'status' => '?string', 'sub_gateway_name' => '?string', 'total' => '\\DocuSign\\eSign\\Model\\Money']

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

getAllowedPaymentMethods()

Gets allowed_payment_methods

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

getChargeId()

Gets charge_id

public getChargeId() : string|null
Return values
string|null —

getCurrencyCode()

Gets currency_code

public getCurrencyCode() : string|null
Return values
string|null —

getCustomerId()

Gets customer_id

public getCustomerId() : string|null
Return values
string|null —

getCustomMetadata()

Gets custom_metadata

public getCustomMetadata() : string|null
Return values
string|null —

getCustomMetadataRequired()

Gets custom_metadata_required

public getCustomMetadataRequired() : bool|null
Return values
bool|null —

getGatewayAccountId()

Gets gateway_account_id

public getGatewayAccountId() : string|null
Return values
string|null —

getGatewayDisplayName()

Gets gateway_display_name

public getGatewayDisplayName() : string|null
Return values
string|null —

getGatewayName()

Gets gateway_name

public getGatewayName() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPaymentOption()

Gets payment_option

public getPaymentOption() : string|null
Return values
string|null —

getPaymentSourceId()

Gets payment_source_id

public getPaymentSourceId() : string|null
Return values
string|null —

getStatus()

Gets status

public getStatus() : string|null
Return values
string|null —

getSubGatewayName()

Gets sub_gateway_name

public getSubGatewayName() : string|null
Return values
string|null —

getters()

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

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

listInvalidProperties()

Show all the invalid properties with reasons.

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

invalid properties with reasons

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 —

setAllowedPaymentMethods()

Sets allowed_payment_methods

public setAllowedPaymentMethods(array<string|int, ?string> $allowed_payment_methods) : $this
Parameters
$allowed_payment_methods : array<string|int, ?string>
Return values
$this —

setChargeId()

Sets charge_id

public setChargeId(string|null $charge_id) : $this
Parameters
$charge_id : string|null
Return values
$this —

setCurrencyCode()

Sets currency_code

public setCurrencyCode(string|null $currency_code) : $this
Parameters
$currency_code : string|null
Return values
$this —

setCurrencyCodeMetadata()

Sets currency_code_metadata

public setCurrencyCodeMetadata(PropertyMetadata $currency_code_metadata) : $this
Parameters
$currency_code_metadata : PropertyMetadata

Metadata that indicates whether the currencyCode property is editable.

Return values
$this —

setCustomerId()

Sets customer_id

public setCustomerId(string|null $customer_id) : $this
Parameters
$customer_id : string|null
Return values
$this —

setCustomMetadata()

Sets custom_metadata

public setCustomMetadata(string|null $custom_metadata) : $this
Parameters
$custom_metadata : string|null
Return values
$this —

setCustomMetadataRequired()

Sets custom_metadata_required

public setCustomMetadataRequired(bool|null $custom_metadata_required) : $this
Parameters
$custom_metadata_required : bool|null
Return values
$this —

setGatewayAccountId()

Sets gateway_account_id

public setGatewayAccountId(string|null $gateway_account_id) : $this
Parameters
$gateway_account_id : string|null
Return values
$this —

setGatewayAccountIdMetadata()

Sets gateway_account_id_metadata

public setGatewayAccountIdMetadata(PropertyMetadata $gateway_account_id_metadata) : $this
Parameters
$gateway_account_id_metadata : PropertyMetadata

Metadata that indicates whether the gatewayAccountId property is editable.

Return values
$this —

setGatewayDisplayName()

Sets gateway_display_name

public setGatewayDisplayName(string|null $gateway_display_name) : $this
Parameters
$gateway_display_name : string|null
Return values
$this —

setGatewayName()

Sets gateway_name

public setGatewayName(string|null $gateway_name) : $this
Parameters
$gateway_name : string|null
Return values
$this —

setPaymentOption()

Sets payment_option

public setPaymentOption(string|null $payment_option) : $this
Parameters
$payment_option : string|null
Return values
$this —

setPaymentSourceId()

Sets payment_source_id

public setPaymentSourceId(string|null $payment_source_id) : $this
Parameters
$payment_source_id : string|null
Return values
$this —

setStatus()

Sets status

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

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Return values
$this —

setSubGatewayName()

Sets sub_gateway_name

public setSubGatewayName(string|null $sub_gateway_name) : $this
Parameters
$sub_gateway_name : string|null
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> —

setTotal()

Sets total

public setTotal(Money $total) : $this
Parameters
$total : Money

This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields.

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

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

Search results