Generate QR code

Generates a QR code for an invoice, by ID. The QR code is a PNG image in Base64-encoded format that corresponds to the invoice ID. You can generate a QR code for an invoice and add it to a paper or PDF invoice. When customers use their mobile devices to scan the QR code, they are redirected to the PayPal mobile payment flow where they can view the invoice and pay online with PayPal or a credit card. Before you get a QR code, you must create an invoice and send an invoice to move the invoice from a draft to payable state. Do not include an email address if you do not want the invoice emailed.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

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

Scopes

For managing (Create, Update, Delete) invoice.https://uri.paypal.com/services/invoicing/invoices/readwrite

Path Parameters

invoice_id*string

The ID of the draft invoice to delete.

Match^.*$

Length0 <= length <= 2147483647

Request Body

application/json

Optional configuration parameters to adjust QR code width, height and the encoded URL.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`multipart/mixed`

`application/json`

curl -X POST "https://api-m.sandbox.paypal.com/v2/invoicing/invoices/string/generate-qr-code" \  -H "Content-Type: application/json" \  -d '{    "width": 400,    "height": 400  }'

Empty

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "debug_id": "string",
  "links": [],
  "details": [
    {
      "issue": "INVALID_INTEGER_MAX_VALUE",
      "description": "Value exceeds max value."
    }
  ]
}

{
  "name": "NOT_AUTHORIZED",
  "message": "Authorization failed due to insufficient permissions.",
  "debug_id": "string",
  "links": [],
  "details": [
    {
      "issue": "PERMISSION_DENIED",
      "description": "The requested invoice is not associated with the requested user."
    }
  ]
}

{
  "name": "RESOURCE_NOT_FOUND",
  "message": "The specified resource does not exist.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred.",
  "debug_id": "90957fca61718",
  "links": [
    {
      "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR",
      "rel": "information_link"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "debug_id": "string",
  "links": []
}

Path Parameters

invoice_id*string

The ID of the draft invoice to delete.

Match^.*$

Length0 <= length <= 2147483647

Request Body

application/json

Optional configuration parameters to adjust QR code width, height and the encoded URL.

TypeScript Definitions

Use the request body type in TypeScript.

width?integer

The width, in pixels, of the QR code image. Value is from 150 to 500.

Default500

Range150 <= value <= 500

height?integer

The height, in pixels, of the QR code image. Value is from 150 to 500.

Default500

Range150 <= value <= 500

action?string

The type of URL for which to generate a QR code. Valid values are pay and details.

Default"pay"

Match^(pay|details)$

Length0 <= length <= 7

{ "name": "INVALID_REQUEST", "message": "Request is not well-formed, syntactically incorrect, or violates schema.", "debug_id": "string", "links": [], "details": [ { "issue": "INVALID_INTEGER_MAX_VALUE", "description": "Value exceeds max value." } ] }

{ "name": "NOT_AUTHORIZED", "message": "Authorization failed due to insufficient permissions.", "debug_id": "string", "links": [], "details": [ { "issue": "PERMISSION_DENIED", "description": "The requested invoice is not associated with the requested user." } ] }

{ "name": "RESOURCE_NOT_FOUND", "message": "The specified resource does not exist.", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "debug_id": "string", "links": [] }

{ "name": "INTERNAL_SERVER_ERROR", "message": "An internal server error occurred.", "debug_id": "90957fca61718", "links": [ { "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR", "rel": "information_link" } ] }

{ "name": "INVALID_REQUEST", "message": "Request is not well-formed, syntactically incorrect, or violates schema.", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "debug_id": "string", "links": [] }

Generate QR code

200

400multipart/mixed

403multipart/mixed

404multipart/mixed

500multipart/mixed

defaultapplication/json

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

Generate QR code

200

400multipart/mixed

403multipart/mixed

404multipart/mixed

500multipart/mixed

defaultapplication/json

`multipart/mixed`

`multipart/mixed`

`multipart/mixed`

`multipart/mixed`

`application/json`

`multipart/mixed`

`multipart/mixed`

`multipart/mixed`

`multipart/mixed`

`application/json`