Overview
  • Namespace
  • Class

Namespaces

  • PayPal
    • Api
    • Auth
    • Cache
    • Common
    • Converter
    • Core
    • Exception
    • Handler
    • Log
    • Rest
    • Security
    • Transport
    • Validation

Classes

  • Address
  • Agreement
  • AgreementDetails
  • AgreementStateDescriptor
  • AgreementTransaction
  • AgreementTransactions
  • AlternatePayment
  • Amount
  • Authorization
  • BankAccount
  • BankAccountsList
  • BankToken
  • BaseAddress
  • Billing
  • BillingAgreementToken
  • BillingInfo
  • CancelNotification
  • Capture
  • CarrierAccount
  • CarrierAccountToken
  • CartBase
  • ChargeModel
  • Cost
  • CountryCode
  • CreateProfileResponse
  • Credit
  • CreditCard
  • CreditCardHistory
  • CreditCardList
  • CreditCardToken
  • CreditFinancingOffered
  • Currency
  • CurrencyConversion
  • CustomAmount
  • DetailedRefund
  • Details
  • Error
  • ErrorDetails
  • ExtendedBankAccount
  • ExternalFunding
  • FileAttachment
  • FlowConfig
  • FmfDetails
  • FundingDetail
  • FundingInstrument
  • FundingOption
  • FundingSource
  • FuturePayment
  • HyperSchema
  • Image
  • Incentive
  • InputFields
  • InstallmentInfo
  • InstallmentOption
  • Invoice
  • InvoiceAddress
  • InvoiceItem
  • InvoiceNumber
  • InvoiceSearchResponse
  • Item
  • ItemList
  • Links
  • Measurement
  • MerchantInfo
  • MerchantPreferences
  • Metadata
  • NameValuePair
  • Notification
  • OpenIdAddress
  • OpenIdError
  • OpenIdSession
  • OpenIdTokeninfo
  • OpenIdUserinfo
  • Order
  • OverrideChargeModel
  • Participant
  • Patch
  • PatchRequest
  • Payee
  • Payer
  • PayerInfo
  • Payment
  • PaymentCard
  • PaymentCardToken
  • PaymentDefinition
  • PaymentDetail
  • PaymentExecution
  • PaymentHistory
  • PaymentInstruction
  • PaymentOptions
  • PaymentSummary
  • PaymentTerm
  • Payout
  • PayoutBatch
  • PayoutBatchHeader
  • PayoutItem
  • PayoutItemDetails
  • PayoutSenderBatchHeader
  • Phone
  • Plan
  • PlanList
  • PotentialPayerInfo
  • Presentation
  • PrivateLabelCard
  • ProcessorResponse
  • RecipientBankingInstruction
  • RedirectUrls
  • Refund
  • RefundDetail
  • RefundRequest
  • RelatedResources
  • Sale
  • Search
  • ShippingAddress
  • ShippingCost
  • ShippingInfo
  • Tax
  • Template
  • TemplateData
  • Templates
  • TemplateSettings
  • TemplateSettingsMetadata
  • Terms
  • Transaction
  • TransactionBase
  • Transactions
  • VerifyWebhookSignature
  • VerifyWebhookSignatureResponse
  • Webhook
  • WebhookEvent
  • WebhookEventList
  • WebhookEventType
  • WebhookEventTypeList
  • WebhookList
  • WebProfile

Class PaymentCard

Class PaymentCard

A payment card that can fund a payment.

PayPal\Common\PayPalModel
Extended by PayPal\Api\PaymentCard
Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/PaymentCard.php

Methods summary

public
# setId( string $id )

The ID of a credit card to save for later use.

The ID of a credit card to save for later use.

Parameters

$id

Returns


$this
public string
# getId( )

The ID of a credit card to save for later use.

The ID of a credit card to save for later use.

Returns

string
public
# setNumber( string $number )

The card number.

The card number.

Parameters

$number

Returns


$this
public string
# getNumber( )

The card number.

The card number.

Returns

string
public
# setType( string $type )

The card type. Valid Values: ["VISA", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "DISCOVER", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFINOGA", "COFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "MASTERCARD"]

The card type. Valid Values: ["VISA", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "DISCOVER", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFINOGA", "COFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "MASTERCARD"]

Parameters

$type

Returns


$this
public string
# getType( )

The card type.

The card type.

Returns

string
public
# setExpireMonth( string $expire_month )

The two-digit expiry month for the card.

The two-digit expiry month for the card.

Parameters

$expire_month

Returns


$this
public string
# getExpireMonth( )

The two-digit expiry month for the card.

The two-digit expiry month for the card.

Returns

string
public
# setExpireYear( string $expire_year )

The four-digit expiry year for the card.

The four-digit expiry year for the card.

Parameters

$expire_year

Returns


$this
public string
# getExpireYear( )

The four-digit expiry year for the card.

The four-digit expiry year for the card.

Returns

string
public
# setStartMonth( string $start_month )

The two-digit start month for the card. Required for UK Maestro cards.

The two-digit start month for the card. Required for UK Maestro cards.

Parameters

$start_month

Returns


$this
public string
# getStartMonth( )

The two-digit start month for the card. Required for UK Maestro cards.

The two-digit start month for the card. Required for UK Maestro cards.

Returns

string
public
# setStartYear( string $start_year )

The four-digit start year for the card. Required for UK Maestro cards.

The four-digit start year for the card. Required for UK Maestro cards.

Parameters

$start_year

Returns


$this
public string
# getStartYear( )

The four-digit start year for the card. Required for UK Maestro cards.

The four-digit start year for the card. Required for UK Maestro cards.

Returns

string
public
# setCvv2( string $cvv2 )

The validation code for the card. Supported for payments but not for saving payment cards for future use.

The validation code for the card. Supported for payments but not for saving payment cards for future use.

Parameters

$cvv2

Returns


$this
public string
# getCvv2( )

The validation code for the card. Supported for payments but not for saving payment cards for future use.

The validation code for the card. Supported for payments but not for saving payment cards for future use.

Returns

string
public
# setFirstName( string $first_name )

The first name of the card holder.

The first name of the card holder.

Parameters

$first_name

Returns


$this
public string
# getFirstName( )

The first name of the card holder.

The first name of the card holder.

Returns

string
public
# setLastName( string $last_name )

The last name of the card holder.

The last name of the card holder.

Parameters

$last_name

Returns


$this
public string
# getLastName( )

The last name of the card holder.

The last name of the card holder.

Returns

string
public
# setBillingCountry( string $billing_country )

The two-letter country code.

The two-letter country code.

Parameters

$billing_country

Returns


$this
public string
# getBillingCountry( )

The two-letter country code.

The two-letter country code.

Returns

string
public
# setBillingAddress( PayPal\Api\Address $billing_address )

The billing address for the card.

The billing address for the card.

Parameters

$billing_address

Returns


$this
public PayPal\Api\Address
# getBillingAddress( )

The billing address for the card.

The billing address for the card.

Returns

PayPal\Api\Address
public
# 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.

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.

Parameters

$external_customer_id

Returns


$this
public string
# getExternalCustomerId( )

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.

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.

Returns

string
public
# setStatus( string $status )

The state of the funding instrument. Valid Values: ["EXPIRED", "ACTIVE"]

The state of the funding instrument. Valid Values: ["EXPIRED", "ACTIVE"]

Parameters

$status

Returns


$this
public string
# getStatus( )

The state of the funding instrument.

The state of the funding instrument.

Returns

string
public
# setCardProductClass( string $card_product_class )

The product class of the financial instrument issuer. Valid Values: ["CREDIT", "DEBIT", "GIFT", "PAYPAL_PREPAID", "PREPAID", "UNKNOWN"]

The product class of the financial instrument issuer. Valid Values: ["CREDIT", "DEBIT", "GIFT", "PAYPAL_PREPAID", "PREPAID", "UNKNOWN"]

Parameters

$card_product_class

Returns


$this
public string
# getCardProductClass( )

The product class of the financial instrument issuer.

The product class of the financial instrument issuer.

Returns

string
public
# setValidUntil( string $valid_until )

The date and time until when this instrument can be used fund a payment.

The date and time until when this instrument can be used fund a payment.

Parameters

$valid_until

Returns


$this
public string
# getValidUntil( )

The date and time until when this instrument can be used fund a payment.

The date and time until when this instrument can be used fund a payment.

Returns

string
public
# setIssueNumber( string $issue_number )

The one- to two-digit card issue number. Required for UK Maestro cards.

The one- to two-digit card issue number. Required for UK Maestro cards.

Parameters

$issue_number

Returns


$this
public string
# getIssueNumber( )

The one- to two-digit card issue number. Required for UK Maestro cards.

The one- to two-digit card issue number. Required for UK Maestro cards.

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

API documentation generated by ApiGen