PHP Class PayPal\Api\PaymentCard

A resource representing a payment card 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.
getBillingAddress ( ) : Address The billing address for the card.
getBillingCountry ( ) : string The two-letter country code.
getCardProductClass ( ) : string The product class of the financial instrument issuer.
getCvv2 ( ) : string The validation code for the card. Supported for payments but not for saving payment cards for future use.
getExpireMonth ( ) : string The two-digit expiry month for the card.
getExpireYear ( ) : string The four-digit expiry year for the card.
getExternalCustomerId ( ) : string The ID of the customer who owns this card account. The facilitator generates and provides this ID. Required when you create or use a stored funding instrument in the PayPal vault.
getFirstName ( ) : string The first name of the card holder.
getId ( ) : string The ID of a credit card to save for later use.
getIssueNumber ( ) : string The one- to two-digit card issue number. Required for UK Maestro cards.
getLastName ( ) : string The last name of the card holder.
getLinks ( ) : PayPal\Api\Links[] Gets Links
getNumber ( ) : string The card number.
getStartMonth ( ) : string The two-digit start month for the card. Required for UK Maestro cards.
getStartYear ( ) : string The four-digit start year for the card. Required for UK Maestro cards.
getStatus ( ) : string The state of the funding instrument.
getType ( ) : string The card type.
getValidUntil ( ) : string The date and time until when this instrument can be used fund a payment.
removeLink ( PayPal\Api\Links $links ) Remove Links from the list.
setBillingAddress ( Address $billing_address ) The billing address for the card.
setBillingCountry ( string $billing_country ) The two-letter country code.
setCardProductClass ( string $card_product_class ) The product class of the financial instrument issuer.
setCvv2 ( string $cvv2 ) The validation code for the card. Supported for payments but not for saving payment cards for future use.
setExpireMonth ( string $expire_month ) The two-digit expiry month for the card.
setExpireYear ( string $expire_year ) The four-digit expiry year for the card.
setExternalCustomerId ( string $external_customer_id ) The ID of the customer who owns this card account. The facilitator generates and provides this ID. Required when you create or use a stored funding instrument in the PayPal vault.
setFirstName ( string $first_name ) The first name of the card holder.
setId ( string $id ) The ID of a credit card to save for later use.
setIssueNumber ( string $issue_number ) The one- to two-digit card issue number. Required for UK Maestro cards.
setLastName ( string $last_name ) The last name of the card holder.
setLinks ( PayPal\Api\Links[] $links ) Sets Links
setNumber ( string $number ) The card number.
setStartMonth ( string $start_month ) The two-digit start month for the card. Required for UK Maestro cards.
setStartYear ( string $start_year ) The four-digit start year for the card. Required for UK Maestro cards.
setStatus ( string $status ) The state of the funding instrument.
setType ( string $type ) The card type.
setValidUntil ( string $valid_until ) The date and time until when this instrument can be used fund a payment.

Method Details

getBillingAddress() public method

The billing address for the card.
public getBillingAddress ( ) : Address
return Address

getBillingCountry() public method

The two-letter country code.
public getBillingCountry ( ) : string
return string

getCardProductClass() public method

The product class of the financial instrument issuer.
public getCardProductClass ( ) : string
return string

getCvv2() public method

The validation code for the card. Supported for payments but not for saving payment cards for future use.
public getCvv2 ( ) : string
return string

getExpireMonth() public method

The two-digit expiry month for the card.
public getExpireMonth ( ) : string
return string

getExpireYear() public method

The four-digit expiry year for the card.
public getExpireYear ( ) : string
return string

getExternalCustomerId() public method

The ID of the customer who owns this card account. The facilitator generates and provides this ID. Required when you create or use a stored funding instrument in the PayPal vault.
public getExternalCustomerId ( ) : string
return string

getFirstName() public method

The first name of the card holder.
public getFirstName ( ) : string
return string

getId() public method

The ID of a credit card to save for later use.
public getId ( ) : string
return string

getIssueNumber() public method

The one- to two-digit card issue number. Required for UK Maestro cards.
public getIssueNumber ( ) : string
return string

getLastName() public method

The last name of the card holder.
public getLastName ( ) : string
return string

getNumber() public method

The card number.
public getNumber ( ) : string
return string

getStartMonth() public method

The two-digit start month for the card. Required for UK Maestro cards.
public getStartMonth ( ) : string
return string

getStartYear() public method

The four-digit start year for the card. Required for UK Maestro cards.
public getStartYear ( ) : string
return string

getStatus() public method

The state of the funding instrument.
public getStatus ( ) : string
return string

getType() public method

The card type.
public getType ( ) : string
return string

getValidUntil() public method

The date and time until when this instrument can be used fund a payment.
public getValidUntil ( ) : string
return string

setBillingAddress() public method

The billing address for the card.
public setBillingAddress ( Address $billing_address )
$billing_address Address

setBillingCountry() public method

The two-letter country code.
public setBillingCountry ( string $billing_country )
$billing_country string

setCardProductClass() public method

Valid Values: ["CREDIT", "DEBIT", "GIFT", "PAYPAL_PREPAID", "PREPAID", "UNKNOWN"]
public setCardProductClass ( string $card_product_class )
$card_product_class string

setCvv2() public method

The validation code for the card. Supported for payments but not for saving payment cards for future use.
public setCvv2 ( string $cvv2 )
$cvv2 string

setExpireMonth() public method

The two-digit expiry month for the card.
public setExpireMonth ( string $expire_month )
$expire_month string

setExpireYear() public method

The four-digit expiry year for the card.
public setExpireYear ( string $expire_year )
$expire_year string

setExternalCustomerId() public method

The ID of the customer who owns this card account. The facilitator generates and provides this ID. Required when you create or use a stored funding instrument in the PayPal vault.
public setExternalCustomerId ( string $external_customer_id )
$external_customer_id string

setFirstName() public method

The first name of the card holder.
public setFirstName ( string $first_name )
$first_name string

setId() public method

The ID of a credit card to save for later use.
public setId ( string $id )
$id string

setIssueNumber() public method

The one- to two-digit card issue number. Required for UK Maestro cards.
public setIssueNumber ( string $issue_number )
$issue_number string

setLastName() public method

The last name of the card holder.
public setLastName ( string $last_name )
$last_name string

setNumber() public method

The card number.
public setNumber ( string $number )
$number string

setStartMonth() public method

The two-digit start month for the card. Required for UK Maestro cards.
public setStartMonth ( string $start_month )
$start_month string

setStartYear() public method

The four-digit start year for the card. Required for UK Maestro cards.
public setStartYear ( string $start_year )
$start_year string

setStatus() public method

Valid Values: ["EXPIRED", "ACTIVE"]
public setStatus ( string $status )
$status string

setType() public method

Valid Values: ["VISA", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "DISCOVER", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFINOGA", "COFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "MASTERCARD"]
public setType ( string $type )
$type string

setValidUntil() public method

The date and time until when this instrument can be used fund a payment.
public setValidUntil ( string $valid_until )
$valid_until string