Mark invoice as paid

Deprecation notice: The /v1/invoices endpoint is deprecated. Use the /v2/invoices endpoint instead. For details, see PayPal Invoicing Basic Integration.

Marks the status of an invoice, by ID, as paid.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage invoice resource.https://uri.paypal.com/services/invoicing

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

datestringOptional

The date when the invoice was paid, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Formatdate-time

methodenumRequired

The payment mode or method.

notestringOptional

A note associated with the payment.

amountobject<currency>Optional

The payment amount to record against the invoice. If you omit this parameter, the total invoice amount is marked as paid. This amount cannot exceed the amount due.

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoicing/invoices/string/record-payment" \  -H "Content-Type: application/json" \  -d '{    "method": "BANK_TRANSFER"  }'

Empty

Mark invoice as paid

API v2

API v1

Deprecation notice: The /v1/invoices endpoint is deprecated. Use the /v2/invoices endpoint instead. For details, see PayPal Invoicing Basic Integration.

Marks the status of an invoice, by ID, as paid.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage invoice resource.https://uri.paypal.com/services/invoicing

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

datestringOptional

The date when the invoice was paid, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Formatdate-time

methodenumRequired

The payment mode or method.

notestringOptional

A note associated with the payment.

amountobject<currency>Optional

The payment amount to record against the invoice. If you omit this parameter, the total invoice amount is marked as paid. This amount cannot exceed the amount due.

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoicing/invoices/string/record-payment" \  -H "Content-Type: application/json" \  -d '{    "method": "BANK_TRANSFER"  }'

Empty

Mark invoice as paid

Authorization

Path Parameters

Request Body

currency properties

Response Body

`application/json`

On this page

On this page

On this page

Mark invoice as paid

Authorization

Path Parameters

Request Body

currency properties

Response Body

`application/json`

On this page

On this page

Mark invoice as paid

currency properties

200

defaultapplication/json

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Mark invoice as paid

currency properties

200

defaultapplication/json

On this page

On this page

`application/json`

`application/json`