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 OpenIdUserinfo

Class OpenIdUserinfo

OpenIdConnect UserInfo Resource

PayPal\Common\PayPalModel
Extended by PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource
Extended by PayPal\Api\OpenIdUserinfo
Namespace: PayPal\Api
Located at PayPal/Api/OpenIdUserinfo.php

Methods summary

public PayPal\Api\OpenIdUserinfo
# setUserId( string $user_id )

Subject - Identifier for the End-User at the Issuer.

Subject - Identifier for the End-User at the Issuer.

Parameters

$user_id

Returns

PayPal\Api\OpenIdUserinfo
public string
# getUserId( )

Subject - Identifier for the End-User at the Issuer.

Subject - Identifier for the End-User at the Issuer.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setSub( string $sub )

Subject - Identifier for the End-User at the Issuer.

Subject - Identifier for the End-User at the Issuer.

Parameters

$sub

Returns

PayPal\Api\OpenIdUserinfo
public string
# getSub( )

Subject - Identifier for the End-User at the Issuer.

Subject - Identifier for the End-User at the Issuer.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setName( string $name )

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

Parameters

$name

Returns

PayPal\Api\OpenIdUserinfo
public string
# getName( )

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setGivenName( string $given_name )

Given name(s) or first name(s) of the End-User

Given name(s) or first name(s) of the End-User

Parameters

$given_name

Returns

PayPal\Api\OpenIdUserinfo
public string
# getGivenName( )

Given name(s) or first name(s) of the End-User

Given name(s) or first name(s) of the End-User

Returns

string
public PayPal\Api\OpenIdUserinfo
# setFamilyName( string $family_name )

Surname(s) or last name(s) of the End-User.

Surname(s) or last name(s) of the End-User.

Parameters

$family_name

Returns

PayPal\Api\OpenIdUserinfo
public string
# getFamilyName( )

Surname(s) or last name(s) of the End-User.

Surname(s) or last name(s) of the End-User.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setMiddleName( string $middle_name )

Middle name(s) of the End-User.

Middle name(s) of the End-User.

Parameters

$middle_name

Returns

PayPal\Api\OpenIdUserinfo
public string
# getMiddleName( )

Middle name(s) of the End-User.

Middle name(s) of the End-User.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setPicture( string $picture )

URL of the End-User's profile picture.

URL of the End-User's profile picture.

Parameters

$picture

Returns

PayPal\Api\OpenIdUserinfo
public string
# getPicture( )

URL of the End-User's profile picture.

URL of the End-User's profile picture.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setEmail( string $email )

End-User's preferred e-mail address.

End-User's preferred e-mail address.

Parameters

$email

Returns

PayPal\Api\OpenIdUserinfo
public string
# getEmail( )

End-User's preferred e-mail address.

End-User's preferred e-mail address.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setEmailVerified( boolean $email_verified )

True if the End-User's e-mail address has been verified; otherwise false.

True if the End-User's e-mail address has been verified; otherwise false.

Parameters

$email_verified

Returns

PayPal\Api\OpenIdUserinfo
public boolean
# getEmailVerified( )

True if the End-User's e-mail address has been verified; otherwise false.

True if the End-User's e-mail address has been verified; otherwise false.

Returns

boolean
public PayPal\Api\OpenIdUserinfo
# setGender( string $gender )

End-User's gender.

End-User's gender.

Parameters

$gender

Returns

PayPal\Api\OpenIdUserinfo
public string
# getGender( )

End-User's gender.

End-User's gender.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setBirthday( string $birthday )

End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.

End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.

Parameters

$birthday

Returns

PayPal\Api\OpenIdUserinfo
public string
# getBirthday( )

End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.

End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setZoneinfo( string $zoneinfo )

Time zone database representing the End-User's time zone

Time zone database representing the End-User's time zone

Parameters

$zoneinfo

Returns

PayPal\Api\OpenIdUserinfo
public string
# getZoneinfo( )

Time zone database representing the End-User's time zone

Time zone database representing the End-User's time zone

Returns

string
public PayPal\Api\OpenIdUserinfo
# setLocale( string $locale )

End-User's locale.

End-User's locale.

Parameters

$locale

Returns

PayPal\Api\OpenIdUserinfo
public string
# getLocale( )

End-User's locale.

End-User's locale.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setLanguage( string $language )

End-User's language.

End-User's language.

Parameters

$language

Returns

PayPal\Api\OpenIdUserinfo
public string
# getLanguage( )

End-User's language.

End-User's language.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setVerified( boolean $verified )

End-User's verified status.

End-User's verified status.

Parameters

$verified

Returns

PayPal\Api\OpenIdUserinfo
public boolean
# getVerified( )

End-User's verified status.

End-User's verified status.

Returns

boolean
public PayPal\Api\OpenIdUserinfo
# setPhoneNumber( string $phone_number )

End-User's preferred telephone number.

End-User's preferred telephone number.

Parameters

$phone_number

Returns

PayPal\Api\OpenIdUserinfo
public string
# getPhoneNumber( )

End-User's preferred telephone number.

End-User's preferred telephone number.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setAddress( PayPal\Api\OpenIdAddress $address )

End-User's preferred address.

End-User's preferred address.

Parameters

$address

Returns

PayPal\Api\OpenIdUserinfo
public PayPal\Api\OpenIdAddress
# getAddress( )

End-User's preferred address.

End-User's preferred address.

Returns

PayPal\Api\OpenIdAddress
public PayPal\Api\OpenIdUserinfo
# setVerifiedAccount( boolean $verified_account )

Verified account status.

Verified account status.

Parameters

$verified_account

Returns

PayPal\Api\OpenIdUserinfo
public boolean
# getVerifiedAccount( )

Verified account status.

Verified account status.

Returns

boolean
public PayPal\Api\OpenIdUserinfo
# setAccountType( string $account_type )

Account type.

Account type.

Parameters

$account_type

Returns

PayPal\Api\OpenIdUserinfo
public string
# getAccountType( )

Account type.

Account type.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setAgeRange( string $age_range )

Account holder age range.

Account holder age range.

Parameters

$age_range

Returns

PayPal\Api\OpenIdUserinfo
public string
# getAgeRange( )

Account holder age range.

Account holder age range.

Returns

string
public PayPal\Api\OpenIdUserinfo
# setPayerId( string $payer_id )

Account payer identifier.

Account payer identifier.

Parameters

$payer_id

Returns

PayPal\Api\OpenIdUserinfo
public string
# getPayerId( )

Account payer identifier.

Account payer identifier.

Returns

string
public static PayPal\Api\OpenIdUserinfo
# getUserinfo( array $params, PayPal\Rest\ApiContext $apiContext = null, PayPalRestCall $restCall = null )

returns user details

returns user details

Parameters

$params

(allowed values are access_token) access_token - access token from the createFromAuthorizationCode / createFromRefreshToken calls

$apiContext
Optional API Context
$restCall

Returns

PayPal\Api\OpenIdUserinfo

Path

/v1/identity/openidconnect/userinfo

Methods inherited from PayPal\Common\PayPalResourceModel

addLink(), executeCall(), getLink(), getLinks(), removeLink(), setLinks(), updateAccessToken()

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