RequestPermissions API Operation

Requests permissions to execute API operations on a PayPal account holder's behalf.

RequestPermissionsRequest Message

RequestPermissions Request Fields

Field

Description

scope

xs:string

(Required) At least 1 of the following permission categories:

  • EXPRESS_CHECKOUT - Express Checkout

  • DIRECT_PAYMENT - Direct payment by debit or credit card

  • SETTLEMENT_CONSOLIDATION - Settlement consolidation

  • SETTLEMENT_REPORTING - Settlement reporting

  • AUTH_CAPTURE - Payment authorization and capture

  • MOBILE_CHECKOUT - Mobile checkout

  • BILLING_AGREEMENT - Billing agreements

  • REFERENCE_TRANSACTION - Reference transactions

  • AIR_TRAVEL - Express Checkout for UTAP

  • MASS_PAY - Mass pay

  • TRANSACTION_DETAILS - Transaction details

  • TRANSACTION_SEARCH - Transaction search

  • RECURRING_PAYMENTS - Recurring payments

  • ACCOUNT_BALANCE - Account balance

  • ENCRYPTED_WEBSITE_PAYMENTS - Encrypted website payments

  • REFUND - Refunds

  • NON_REFERENCED_CREDIT - Non-referenced credit

  • BUTTON_MANAGER - Button Manager

  • MANAGE_PENDING_TRANSACTION_STATUS includes ManagePendingTransactionStatus

  • RECURRING_PAYMENT_REPORT - Reporting for recurring payments

  • EXTENDED_PRO_PROCESSING_REPORT - Extended Pro processing

  • EXCEPTION_PROCESSING_REPORT - Exception processing

  • ACCOUNT_MANAGEMENT_PERMISSION - Account Management Permission (MAM)

  • ACCESS_BASIC_PERSONAL_DATA - User attributes

  • ACCESS_ADVANCED_PERSONAL_DATA - User attributes

  • INVOICING - Invoicing

callback

xs:string

(Required) Your callback function that specifies actions to take after the account holder grants or denies the request.

requestEnvelope

common:requestEnvelope

(Required) Information common to each API operation, such as the language in which an error message is returned.

RequestEnvelope Fields

Field

Description

detailLevel

common:DetailLevelCode

(Optional) Level of detail required by the client application for components. Value is:


  • ReturnAll — This value provides the maximum level of detail (default).

errorLanguage

xs:string

(Required) RFC 3066 language in which error messages are returned; by default it is en_US, which is the only language currently supported.

RequestPermissionsResponse Message

RequestPermissions Response Fields

Field

Description

token

xs:string

(Required) A token from PayPal that enables the request to obtain permissions.

responseEnvelope

common:ResponseEnvelope

Common response information, including a timestamp and the response acknowledgment status.

ResponseEnvelope Fields

Field

Description

ack

common:AckCode

Acknowledgment code. Value is:

  • Success — The operation completed successfully.

  • Failure — The operation failed.

  • Warning — Warning.

  • SuccessWithWarning — The operation completed successfully; however, there is a warning message.

  • FailureWithWarning — The operation failed with a warning message.

build

Build number; it is used only by Developer Technical Support.

correlationId

Correlation ID; it is used only by Developer 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.

timestamp

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

error

common:ErrorData

Detailed error information.

responseEnvelope

common:ResponseEnvelope

Common response information, including a timestamp and the response acknowledgment status.

ErrorData Fields

Field

Description

category

common:ErrorCategory

The location where the error occurred.

Value is:

  • System — The system encountered errors; try again

  • Application — The application encountered errors; try again

  • Request — The request was incorrect

domain

The domain to which this service belongs.

errorId

A number that uniquely identifies a particular error.

exceptionID

This field is not used.

message

A description of the error.

parameter

common:ErrorParameter

Represents contextual information about the error.

severity

common:ErrorSeverity

The severity of the error encountered.

Value is:

  • Error — Processing of the request was interrupted

  • Warning — Processing of the request was completed

subdomain

This field is not used.

ResponseEnvelope Fields

Field

Description

ack

common:AckCode

Acknowledgment code. Value is:

  • Success — The operation completed successfully.

  • Failure — The operation failed.

  • Warning — Warning.

  • SuccessWithWarning — The operation completed successfully; however, there is a warning message.

  • FailureWithWarning — The operation failed with a warning message.

build

Build number; it is used only by Developer Technical Support.

correlationId

Correlation ID; it is used only by Developer 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.

timestamp

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.

RequestPermission Errors

Code

Message

Additional Information

520002

Internal error

550001

User is not allowed to perform this action

560022

Invalid API Caller Account

580022

Transaction refused because of an invalid argument. See additional error messages for details.

580028

Invalid Redirect URL