PHP Class PayPal\EBLBaseComponents\RefreshTokenStatusDetailsType

Inheritance: extends PayPal\Core\PPXmlMessage
Show file Open project: paypal/merchant-sdk-php

Public Properties

Property Type Description
$ImmutableID string The immutable_id is the user's unique value per merchant that should never ever change for that account. This would be the key used to uniquely identify the user
$RefreshToken string Identifier returned on external-remember-me-opt-in to allow the merchant to request bypass of PayPal login
$RefreshTokenStatus integer Required field that reports status of opt-in or login bypass attempt. 0 = Success, successful opt-in or RefreshToken corresponding to AccessToken specified in SetExpressCheckout is valid (user is still opted in). 1 = New RefreshToken was generated (user is still opted in). 2 = Invalid ID, RefreshToken corresponding to AccessToken specified in SetExpressCheckout is invalid (user is opted out). -2 = Internal Error, system error or outage during opt-in or login bypass. Can retry opt-in or login bypass next time. Flow will force full authentication and allow buyer to complete transaction. -1 = None, the field does not represent any valid value of the status.

Property Details

$ImmutableID public property

The immutable_id is the user's unique value per merchant that should never ever change for that account. This would be the key used to uniquely identify the user
public string $ImmutableID
return string

$RefreshToken public property

Identifier returned on external-remember-me-opt-in to allow the merchant to request bypass of PayPal login
public string $RefreshToken
return string

$RefreshTokenStatus public property

Required field that reports status of opt-in or login bypass attempt. 0 = Success, successful opt-in or RefreshToken corresponding to AccessToken specified in SetExpressCheckout is valid (user is still opted in). 1 = New RefreshToken was generated (user is still opted in). 2 = Invalid ID, RefreshToken corresponding to AccessToken specified in SetExpressCheckout is invalid (user is opted out). -2 = Internal Error, system error or outage during opt-in or login bypass. Can retry opt-in or login bypass next time. Flow will force full authentication and allow buyer to complete transaction. -1 = None, the field does not represent any valid value of the status.
public int $RefreshTokenStatus
return integer