GetAccessToken API Operation
Gets an access token for a set of permissions.
GetAccessTokenRequest Message
GetAccessTokenRequest Fields
Field |
Description |
---|---|
|
(Required) The request token from the response to RequestPermissions. |
|
(Required) The verification code returned in the redirect from PayPal to the return URL. |
|
Do not use. |
|
(Required) Information common to each API operation, such as the language in which an error message is returned. |
RequestEnvelope Fields
Field |
Description |
---|---|
|
(Optional) Level of detail required by the client application for components. Value is:
|
|
(Required) RFC 3066 language in which error messages are returned; by default it is |
GetAccessToken Response Message
GetAccessTokenResponse Fields
Field |
Description |
---|---|
|
The group IDs of the permission categories associated with the access token:
|
|
The access token that identifies a set of permissions. |
|
The secret associated with the access token. |
|
Common response information, including a timestamp and the response acknowledgment status. |
ResponseEnvelope Fields
Field |
Description |
---|---|
|
Acknowledgment code. Value is:
|
|
Build number; it is used only by Merchant Technical Support. |
|
Correlation ID; it is used only by Merchant Technical Support. Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
|
Date on which the response was sent. The time is currently not supported. Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
PPFault Message
The PPFaultMessage
returns ErrorData
and the ResponseEnvelope
information to your application if an error occurs.
FaultMessage Fields
Field |
Description |
---|---|
|
Detailed error information. |
|
Common response information, including a timestamp and the response acknowledgment status. |
ErrorData Fields
Field |
Description |
---|---|
|
The location where the error occurred. Value is:
|
|
The domain to which this service belongs. |
|
A number that uniquely identifies a particular error. |
|
This field is not used. |
|
A description of the error. |
|
Represents contextual information about the error. |
|
The severity of the error encountered. Value is:
|
|
This field is not used. |
ResponseEnvelope Fields
Field |
Description |
---|---|
|
Acknowledgment code. Value is:
|
|
Build number; it is used only by Merchant Technical Support. |
|
Correlation ID; it is used only by Merchant Technical Support. Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
|
Date on which the response was sent. The time is currently not supported. Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
GetAccessToken Errors
Code |
Message |
Additional Information |
---|---|---|
579058 |
Request token is Expired |
|
580022 |
Invalid Request token or Verifier Code |
|