Class BankAccount

A resource representing a bank account that can be used to fund a payment.

PayPal\Api\BankAccount

Direct known subclasses

PayPal\Api\ExtendedBankAccount

Namespace: PayPal\Api
Package: PayPal\Api
Deprecated: Deprecated. It is for internal use only. It may be removed in next major revision.
Located at PayPal/Api/BankAccount.php

Methods summary

`public`	# `setId( string $id )` ID of the bank account being saved for later use. ID of the bank account being saved for later use. Parameters `$id` Returns $this
`public string`	# `getId( )` ID of the bank account being saved for later use. ID of the bank account being saved for later use. Returns string
`public`	# `setAccountNumber( string $account_number )` Account number in either IBAN (max length 34) or BBAN (max length 17) format. Account number in either IBAN (max length 34) or BBAN (max length 17) format. Parameters `$account_number` Returns $this
`public string`	# `getAccountNumber( )` Account number in either IBAN (max length 34) or BBAN (max length 17) format. Account number in either IBAN (max length 34) or BBAN (max length 17) format. Returns string
`public`	# `setAccountNumberType( string $account_number_type )` Type of the bank account number (International or Basic Bank Account Number). For more information refer to http://en.wikipedia.org/wiki/International_Bank_Account_Number. Valid Values: ["BBAN", "IBAN"] Type of the bank account number (International or Basic Bank Account Number). For more information refer to http://en.wikipedia.org/wiki/International_Bank_Account_Number. Valid Values: ["BBAN", "IBAN"] Parameters `$account_number_type` Returns $this
`public string`	# `getAccountNumberType( )` Type of the bank account number (International or Basic Bank Account Number). For more information refer to http://en.wikipedia.org/wiki/International_Bank_Account_Number. Type of the bank account number (International or Basic Bank Account Number). For more information refer to http://en.wikipedia.org/wiki/International_Bank_Account_Number. Returns string
`public`	# `setRoutingNumber( string $routing_number )` Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code). For more information refer to http://en.wikipedia.org/wiki/Bank_code. Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code). For more information refer to http://en.wikipedia.org/wiki/Bank_code. Parameters `$routing_number` Returns $this
`public string`	# `getRoutingNumber( )` Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code). For more information refer to http://en.wikipedia.org/wiki/Bank_code. Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code). For more information refer to http://en.wikipedia.org/wiki/Bank_code. Returns string
`public`	# `setAccountType( string $account_type )` Type of the bank account. Valid Values: ["CHECKING", "SAVINGS"] Type of the bank account. Valid Values: ["CHECKING", "SAVINGS"] Parameters `$account_type` Returns $this
`public string`	# `getAccountType( )` Type of the bank account. Type of the bank account. Returns string
`public`	# `setAccountName( string $account_name )` A customer designated name. A customer designated name. Parameters `$account_name` Returns $this
`public string`	# `getAccountName( )` A customer designated name. A customer designated name. Returns string
`public`	# `setCheckType( string $check_type )` Type of the check when this information was obtained through a check by the facilitator or merchant. Valid Values: ["PERSONAL", "COMPANY"] Type of the check when this information was obtained through a check by the facilitator or merchant. Valid Values: ["PERSONAL", "COMPANY"] Parameters `$check_type` Returns $this
`public string`	# `getCheckType( )` Type of the check when this information was obtained through a check by the facilitator or merchant. Type of the check when this information was obtained through a check by the facilitator or merchant. Returns string
`public`	# `setAuthType( string $auth_type )` How the check was obtained from the customer, if check was the source of the information provided. Valid Values: ["CCD", "PPD", "TEL", "POP", "ARC", "RCK", "WEB"] How the check was obtained from the customer, if check was the source of the information provided. Valid Values: ["CCD", "PPD", "TEL", "POP", "ARC", "RCK", "WEB"] Parameters `$auth_type` Returns $this
`public string`	# `getAuthType( )` How the check was obtained from the customer, if check was the source of the information provided. How the check was obtained from the customer, if check was the source of the information provided. Returns string
`public`	# `setAuthCaptureTimestamp( string $auth_capture_timestamp )` Time at which the authorization (or check) was captured. Use this field if the user authorization needs to be captured due to any privacy requirements. Time at which the authorization (or check) was captured. Use this field if the user authorization needs to be captured due to any privacy requirements. Parameters `$auth_capture_timestamp` Returns $this
`public string`	# `getAuthCaptureTimestamp( )` Time at which the authorization (or check) was captured. Use this field if the user authorization needs to be captured due to any privacy requirements. Time at which the authorization (or check) was captured. Use this field if the user authorization needs to be captured due to any privacy requirements. Returns string
`public`	# `setBankName( string $bank_name )` Name of the bank. Name of the bank. Parameters `$bank_name` Returns $this
`public string`	# `getBankName( )` Name of the bank. Name of the bank. Returns string
`public`	# `setCountryCode( string $country_code )` 2 letter country code of the Bank. 2 letter country code of the Bank. Parameters `$country_code` Returns $this
`public string`	# `getCountryCode( )` 2 letter country code of the Bank. 2 letter country code of the Bank. Returns string
`public`	# `setFirstName( string $first_name )` Account holder's first name. Account holder's first name. Parameters `$first_name` Returns $this
`public string`	# `getFirstName( )` Account holder's first name. Account holder's first name. Returns string
`public`	# `setLastName( string $last_name )` Account holder's last name. Account holder's last name. Parameters `$last_name` Returns $this
`public string`	# `getLastName( )` Account holder's last name. Account holder's last name. Returns string
`public`	# `setBirthDate( string $birth_date )` Birth date of the bank account holder. Birth date of the bank account holder. Parameters `$birth_date` Returns $this
`public string`	# `getBirthDate( )` Birth date of the bank account holder. Birth date of the bank account holder. Returns string
`public`	# `setBillingAddress( PayPal\Api\Address $billing_address )` Billing address. Billing address. Parameters `$billing_address` Returns $this
`public PayPal\Api\Address`	# `getBillingAddress( )` Billing address. Billing address. Returns `PayPal\Api\Address`
`public`	# `setState( string $state )` State of this funding instrument. Valid Values: ["ACTIVE", "INACTIVE", "DELETED"] State of this funding instrument. Valid Values: ["ACTIVE", "INACTIVE", "DELETED"] Parameters `$state` Returns $this
`public string`	# `getState( )` State of this funding instrument. State of this funding instrument. Returns string
`public`	# `setConfirmationStatus( string $confirmation_status )` Confirmation status of a bank account. Valid Values: ["UNCONFIRMED", "CONFIRMED"] Confirmation status of a bank account. Valid Values: ["UNCONFIRMED", "CONFIRMED"] Parameters `$confirmation_status` Returns $this
`public string`	# `getConfirmationStatus( )` Confirmation status of a bank account. Confirmation status of a bank account. Returns string
`public`	# `setPayerId( string $payer_id )` [DEPRECATED] Use external_customer_id instead. [DEPRECATED] Use external_customer_id instead. Parameters `$payer_id` Returns $this
`public string`	# `getPayerId( )` Returns string
`public`	# `setExternalCustomerId( string $external_customer_id )` A unique identifier of the customer to whom this bank account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault. A unique identifier of the customer to whom this bank account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault. Parameters `$external_customer_id` Returns $this
`public string`	# `getExternalCustomerId( )` A unique identifier of the customer to whom this bank account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault. A unique identifier of the customer to whom this bank account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault. Returns string
`public`	# `setMerchantId( string $merchant_id )` A unique identifier of the merchant for which this bank account has been stored for. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant. A unique identifier of the merchant for which this bank account has been stored for. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant. Parameters `$merchant_id` Returns $this
`public string`	# `getMerchantId( )` A unique identifier of the merchant for which this bank account has been stored for. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant. A unique identifier of the merchant for which this bank account has been stored for. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant. Returns string
`public`	# `setCreateTime( string $create_time )` Time the resource was created. Time the resource was created. Parameters `$create_time` Returns $this
`public string`	# `getCreateTime( )` Time the resource was created. Time the resource was created. Returns string
`public`	# `setUpdateTime( string $update_time )` Time the resource was last updated. Time the resource was last updated. Parameters `$update_time` Returns $this
`public string`	# `getUpdateTime( )` Time the resource was last updated. Time the resource was last updated. Returns string
`public`	# `setValidUntil( string $valid_until )` Date/Time until this resource can be used to fund a payment. Date/Time until this resource can be used to fund a payment. Parameters `$valid_until` Returns $this
`public string`	# `getValidUntil( )` Date/Time until this resource can be used to fund a payment. Date/Time until this resource can be used to fund a payment. Returns string
`public`	# `setLinks( PayPal\Api\Links[] $links )` Sets Links Sets Links Parameters `$links` Returns $this
`public PayPal\Api\Links[]`	# `getLinks( )` Gets Links Gets Links Returns `PayPal\Api\Links[]`
`public`	# `addLink( PayPal\Api\Links $links )` Append Links to the list. Append Links to the list. Parameters `$links` Returns $this
`public`	# `removeLink( PayPal\Api\Links $links )` Remove Links from the list. Remove Links from the list. Parameters `$links` Returns $this

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

Namespaces

Classes

Class BankAccount

Direct known subclasses

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters