On this page
No Headings
MarkInvoiceAsPaid API Operation
Last updated: June 12, 2026
API
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.
Marks an invoice as paid.
MarkInvoiceAsPaidRequest Message
Use the MarkInvoiceAsPaidRequest message to mark an invoice as paid.
RequestEnvelope Fields
| Field | Description |
|---|---|
detailLevel | common:DetailLevelCode (Optional) Level of detail required by the client application pertaining to a particular data component. The detail level is specified as a detail level code, which has all the enumerated values of the detail level for the component. By default, the detail level code is ReturnAll, which provides the maximum level of detail. |
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. |
MarkInvoiceAsPaidRequest Fields
| Field | Description |
|---|---|
invoiceID | xs:string (Required) ID of the invoice to mark as paid. |
payment | inv:OtherPaymentDetailsType (Required) Details of the payment made against this type. |
requestEnvelope | common:requestEnvelope (Required) Information common to each API operation, such as the language in which an error message is returned. |
OtherPaymentDetailsType Fields
| Field | Description |
|---|---|
method | inv:PaymentMethodsType (Optional) Method that can be used to mark an invoice as paid when the payer pays offline. Value is:
|
note | xs:string (Optional) Optional note associated with the payment. |
date | xs:dateTime (Required) Date when the invoice was paid. |
MarkInvoiceAsPaidResponse Message
The MarkInvoiceAsPaidResponse message marks an invoice as paid.
ResponseEnvelope Fields
| Field | Description |
|---|---|
ack | common:AckCode Acknowledgment code. Value is:
|
build | xs:string Build number. It is used only by PayPal Merchant Technical Support. |
correlationId | xs:string Correlation identifier. It is a 13-character, alphanumeric string (for example, db87c705a910e) that is used only by PayPal 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. |
timestamp | xs:datetime Date on which the response was sent, for example: 2012-04-02T22:33:35.774-07:00 Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
MarkInvoiceAsPaidResponse Fields
| Field | Description |
|---|---|
responseEnvelope | common:ResponseEnvelope Common response information, including a timestamp and the response acknowledgment status. |
invoiceID | xs:string ID of the invoice marked as paid. |
invoiceNumber | xs:string Number of the invoice marked as paid. |
invoiceURL | xs:string URL location where merchants view the invoice details. |
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:
|
domain | xs:string The domain to which this service belongs. |
errorId | xs:long A 6-digit number that uniquely identifies a particular error. |
exceptionID | This field is not used. |
message | xs:string 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:
|
subdomain | This field is not used. |
ResponseEnvelope Fields
| Field | Description |
|---|---|
ack | common:AckCode Acknowledgment code. Value is:
|
build | xs:string Build number. It is used only by PayPal Merchant Technical Support. |
correlationId | xs:string Correlation identifier. It is a 13-character, alphanumeric string (for example, db87c705a910e) that is used only by PayPal 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. |
timestamp | xs:datetime Date on which the response was sent, for example: 2012-04-02T22:33:35.774-07:00 Note: You must log and store this data for every response you receive. PayPal Technical Support uses the information to assist with reported issues. |
MarkInvoiceAsPaid API Errors
| Code | Message | Additional Information |
|---|---|---|
| 520002 | Internal error. | |
| 520003 | Authentication failed. API credentials are incorrect. | |
| 520009 | Account is restricted. | |
| 550026 | Partner did not create the invoice but attempted to access or modify it; a merchant's invoice can be accessed or modified only by the partner who created it. | |
| 550027 | Merchant cannot access or modify an invoice they did not create; an invoice can only be accessed or modified by the party who created it. | |
| 570058 | Authentication failed. User account is not confirmed. | |
| 570065 | Invoice cannot be marked as paid since it has already been paid. | |
| 570066 | The payment method of the invoice is invalid. | |
| 571001 | The specified invoice ID is invalid because the invoice has already been deleted. | |
| 580022 | This error code corresponds to validation error messages that deal with errors of supplied parameters. | |
| 580047 | Invoice does not exist. |