PHP Class PayPal\Api\BankAccount

A resource representing a bank account that can be used to fund a payment.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addLink ( PayPal\Api\Links $links ) Append Links to the list.
getAccountName ( ) : string A customer designated name.
getAccountNumber ( ) : string Account number in either IBAN (max length 34) or BBAN (max length 17) format.
getAccountNumberType ( ) : string 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.
getAccountType ( ) : string Type of the bank account.
getAuthCaptureTimestamp ( ) : string 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.
getAuthType ( ) : string How the check was obtained from the customer, if check was the source of the information provided.
getBankName ( ) : string Name of the bank.
getBillingAddress ( ) : Address Billing address.
getBirthDate ( ) : string Birth date of the bank account holder.
getCheckType ( ) : string Type of the check when this information was obtained through a check by the facilitator or merchant.
getConfirmationStatus ( ) : string Confirmation status of a bank account.
getCountryCode ( ) : string 2 letter country code of the Bank.
getCreateTime ( ) : string Time the resource was created.
getExternalCustomerId ( ) : string 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.
getFirstName ( ) : string Account holder's first name.
getId ( ) : string ID of the bank account being saved for later use.
getLastName ( ) : string Account holder's last name.
getLinks ( ) : PayPal\Api\Links[] Gets Links
getMerchantId ( ) : string 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.
getPayerId ( ) : string
getRoutingNumber ( ) : string 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.
getState ( ) : string State of this funding instrument.
getUpdateTime ( ) : string Time the resource was last updated.
getValidUntil ( ) : string Date/Time until this resource can be used to fund a payment.
removeLink ( PayPal\Api\Links $links ) Remove Links from the list.
setAccountName ( string $account_name ) A customer designated name.
setAccountNumber ( string $account_number ) Account number in either IBAN (max length 34) or BBAN (max length 17) format.
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.
setAccountType ( string $account_type ) Type of the bank account.
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.
setAuthType ( string $auth_type ) How the check was obtained from the customer, if check was the source of the information provided.
setBankName ( string $bank_name ) Name of the bank.
setBillingAddress ( Address $billing_address ) Billing address.
setBirthDate ( string $birth_date ) Birth date of the bank account holder.
setCheckType ( string $check_type ) Type of the check when this information was obtained through a check by the facilitator or merchant.
setConfirmationStatus ( string $confirmation_status ) Confirmation status of a bank account.
setCountryCode ( string $country_code ) 2 letter country code of the Bank.
setCreateTime ( string $create_time ) Time the resource was created.
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.
setFirstName ( string $first_name ) Account holder's first name.
setId ( string $id ) ID of the bank account being saved for later use.
setLastName ( string $last_name ) Account holder's last name.
setLinks ( PayPal\Api\Links[] $links ) Sets Links
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.
setPayerId ( string $payer_id ) [DEPRECATED] Use external_customer_id instead.
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.
setState ( string $state ) State of this funding instrument.
setUpdateTime ( string $update_time ) Time the resource was last updated.
setValidUntil ( string $valid_until ) Date/Time until this resource can be used to fund a payment.

Method Details

getAccountName() public method

A customer designated name.
public getAccountName ( ) : string
return string

getAccountNumber() public method

Account number in either IBAN (max length 34) or BBAN (max length 17) format.
public getAccountNumber ( ) : string
return string

getAccountNumberType() public method

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.
public getAccountNumberType ( ) : string
return string

getAccountType() public method

Type of the bank account.
public getAccountType ( ) : string
return string

getAuthCaptureTimestamp() public method

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.
public getAuthCaptureTimestamp ( ) : string
return string

getAuthType() public method

How the check was obtained from the customer, if check was the source of the information provided.
public getAuthType ( ) : string
return string

getBankName() public method

Name of the bank.
public getBankName ( ) : string
return string

getBillingAddress() public method

Billing address.
public getBillingAddress ( ) : Address
return Address

getBirthDate() public method

Birth date of the bank account holder.
public getBirthDate ( ) : string
return string

getCheckType() public method

Type of the check when this information was obtained through a check by the facilitator or merchant.
public getCheckType ( ) : string
return string

getConfirmationStatus() public method

Confirmation status of a bank account.
public getConfirmationStatus ( ) : string
return string

getCountryCode() public method

2 letter country code of the Bank.
public getCountryCode ( ) : string
return string

getCreateTime() public method

Time the resource was created.
public getCreateTime ( ) : string
return string

getExternalCustomerId() public method

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.
public getExternalCustomerId ( ) : string
return string

getFirstName() public method

Account holder's first name.
public getFirstName ( ) : string
return string

getId() public method

ID of the bank account being saved for later use.
Deprecation: Not publicly available
public getId ( ) : string
return string

getLastName() public method

Account holder's last name.
public getLastName ( ) : string
return string

getMerchantId() public method

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.
public getMerchantId ( ) : string
return string

getPayerId() public method

Deprecation: [DEPRECATED] Use external_customer_id instead.
public getPayerId ( ) : string
return string

getRoutingNumber() public method

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.
public getRoutingNumber ( ) : string
return string

getState() public method

State of this funding instrument.
public getState ( ) : string
return string

getUpdateTime() public method

Time the resource was last updated.
public getUpdateTime ( ) : string
return string

getValidUntil() public method

Date/Time until this resource can be used to fund a payment.
public getValidUntil ( ) : string
return string

setAccountName() public method

A customer designated name.
public setAccountName ( string $account_name )
$account_name string

setAccountNumber() public method

Account number in either IBAN (max length 34) or BBAN (max length 17) format.
public setAccountNumber ( string $account_number )
$account_number string

setAccountNumberType() public method

Valid Values: ["BBAN", "IBAN"]
public setAccountNumberType ( string $account_number_type )
$account_number_type string

setAccountType() public method

Valid Values: ["CHECKING", "SAVINGS"]
public setAccountType ( string $account_type )
$account_type string

setAuthCaptureTimestamp() public method

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.
public setAuthCaptureTimestamp ( string $auth_capture_timestamp )
$auth_capture_timestamp string

setAuthType() public method

Valid Values: ["CCD", "PPD", "TEL", "POP", "ARC", "RCK", "WEB"]
public setAuthType ( string $auth_type )
$auth_type string

setBankName() public method

Name of the bank.
public setBankName ( string $bank_name )
$bank_name string

setBillingAddress() public method

Billing address.
public setBillingAddress ( Address $billing_address )
$billing_address Address

setBirthDate() public method

Birth date of the bank account holder.
public setBirthDate ( string $birth_date )
$birth_date string

setCheckType() public method

Valid Values: ["PERSONAL", "COMPANY"]
public setCheckType ( string $check_type )
$check_type string

setConfirmationStatus() public method

Valid Values: ["UNCONFIRMED", "CONFIRMED"]
public setConfirmationStatus ( string $confirmation_status )
$confirmation_status string

setCountryCode() public method

2 letter country code of the Bank.
public setCountryCode ( string $country_code )
$country_code string

setCreateTime() public method

Time the resource was created.
public setCreateTime ( string $create_time )
$create_time string

setExternalCustomerId() public method

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.
public setExternalCustomerId ( string $external_customer_id )
$external_customer_id string

setFirstName() public method

Account holder's first name.
public setFirstName ( string $first_name )
$first_name string

setId() public method

ID of the bank account being saved for later use.
Deprecation: Not publicly available
public setId ( string $id )
$id string

setLastName() public method

Account holder's last name.
public setLastName ( string $last_name )
$last_name string

setMerchantId() public method

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.
public setMerchantId ( string $merchant_id )
$merchant_id string

setPayerId() public method

[DEPRECATED] Use external_customer_id instead.
public setPayerId ( string $payer_id )
$payer_id string

setRoutingNumber() public method

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.
public setRoutingNumber ( string $routing_number )
$routing_number string

setState() public method

Valid Values: ["ACTIVE", "INACTIVE", "DELETED"]
public setState ( string $state )
$state string

setUpdateTime() public method

Time the resource was last updated.
public setUpdateTime ( string $update_time )
$update_time string

setValidUntil() public method

Date/Time until this resource can be used to fund a payment.
public setValidUntil ( string $valid_until )
$valid_until string