UpdateComplianceStatus API Operation

API

Last updated: Aug 15th, 6:17am

Important: The Adaptive Platform API is not available for new integrations. PayPal provides this documentation to support existing integrations. If you're starting an integration, we recommend our latest solutions.

Sets the compliance status of a PayPal account. In addition, this API lets you supply basic audit trail information.

Note: Currently, this API works for Japanese PayPal accounts only.

UpdateComplianceStatusRequest Message

The UpdateComplianceStatusRequest message supplies information for setting the compliance status of the specified the PayPal account.

UpdateComplianceStatusRequest Fields

Field	Description
`accountIdentifier`	`aa:AccountIdentifierType` (Required) Identifies the PayPal account for which to set compliance status. Must be one (and only one) of these account identifier types: `emailAddress`, `xs:string` (Optional) Email address of the PayPal account holder `mobilePhoneNumber`, `xs:string` (Optional) Mobile phone number of the PayPal account holder `accountId`, `xs:string` (Optional) Account Id of the PayPal account holder
`auditDetails`	`aa:AuditDetailsType` (Required) A structure containing information about the audit performed to establish compliance. See AuditDetailsType Fields for details.
`auditeeInfo`	`aa:AuditeeInfoType` (Required) A structure containing information describing the customer that was audited. See AuditeeInfoType Fields for details.
`auditorList`	`aa:AuditorList` (Optional) A structure containing information identifying the officer(s) that performed the audit. See AuditorList Fields for details.
`requestEnvelope`	`common:RequestEnvelope` (Required) Information common to all API operations, such as the language in which an error message is returned. See RequestEnvelope Fields for details.

AuditDetailsType Fields

Field	Description
`data`	`aa:TupleType` (Optional) A structure containing any number of name-value pairs. See TupleType Fields for details.
`level`	`xs:string` (Required) Audit level
`method`	`xs:string` (Required) Audit method
`policyVersion`	`xs:string` (Optional) Version of the audit policy used
`reason`	`xs:string` (Required) Reason for the audit
`status`	`xs:string` (Required) Status of the audit

AuditeeInfoType Fields

Field	Description
`accountIdentifier`	`aa:AccountIdentifierType` (Required) Identifies the PayPal account that was audited. Must be one (and only one) of these account identifier types: `emailAddress`, `xs:string` (Optional) Email address of the PayPal account holder `mobilePhoneNumber`, `xs:string` (Optional) Mobile phone number of the PayPal account holder `accountId`, `xs:string` (Optional) Account Id of the PayPal account holder
`data`	`aa:TupleType` (Optional) A structure containing any number of name-value pairs. See TupleType Fields for details.
`document`	`aa:DocumentType` (Optional) A structure containing information about an audit document. See DocumentType Fields for details.

AuditorList Fields

Field	Description
`auditor`	`aa:Auditor` (Required) A structure containing any number of Auditor structures. See Auditor Fields for details.

TupleType Fields

Field	Description
`name`	`xs:string` (Required) The name component of a name-value pair
`value`	`xs:string` (Required) The value component of a name-value pair

DocumentType Fields

Field	Description
`filename`	`xs:string` (Required) The file name of an audit document
`type`	`xs:string` (Required) The type of audit document

Auditor Fields

Field	Description
`action`	`xs:string` (Required) Action taken by the auditor
`id`	`xs:string` (Required) Value that identifies an auditor within his company
`name`	`xs:string` (Required) Auditor's name
`notes`	`xs:string` (Optional) Notes from auditor pertaining to the compliance update

RequestEnvelope Fields

Field	Description
`detailLevel`	`common:DetailLevelCode` The level of detail required by the client application for components such as Item, Transaction. Allowed values are: `ReturnAll` - This value provides the maximum level of detail (default)
`errorLanguage`	`xs:string` The RFC 3066 language in which error messages are returned; by default, this language is `en_US`—the only language currently supported.

UpdateComplianceStatusResponse Message

The UpdateComplianceStatusResponse message returns the results of the update compliance status request.

UpdateComplianceStatusResponse Fields

Field	Definition
`execStatus`	`xs:string` Indicates whether to allow the requested action. Possible values: `ALLOW` - Allow the requested the action. `DENY` - Deny the requested action.
`responseEnvelope`	`common:ResponseEnvelope` Common response information, including a timestamp and the response acknowledgment status. See ResponseEnvelope Fields for details.

ResponseEnvelope Fields

Field	Description
`ack`	`common:AckCode` Acknowledgment code. Possible values: `Success` - Operation completed successfully `Failure` - Operation failed `Warning` - Warning `SuccessWithWarning` - Operation completed successfully; however, there is a warning message. `FailureWithWarning` - Operation failed with a warning message
`build`	Build number - Used only by Merchant Technical Support.
`correlationId`	Correlation ID - Used only by Merchant Technical Support.
`timestamp`	The date on which the response was sent. The time is not supported.

UpdateComplianceStatus Errors

Error Code	Error Message	Additional Information
550001	User is not allowed to perform this action	The user does not have permission to call this API.
580022	Invalid request parameter: accountIdentifier	Invalid accountIdentifier information
580027	The parameter is not supported: auditDetails.level	The supplied audit details level is not supported by the API call
580029	Missing required request parameter: <name> accountIdentifier auditDetails.level auditDetails.status auditDetails.method auditDetails.reason auditDetails.data.sales_channel auditDetails.data.verification_action_taken auditDetails.data.callee_name auditDetails.data.call_data	Missing required request parameter: <name>