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.

POST /v2/invoicing/invoices/{invoice_id}/generate-qr-code

Generate QR code

cURL

curl --request POST \
  --url https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{invoice_id}/generate-qr-code \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "width": 400,
  "height": 400
}
'

400

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

Authorizations

Authorization · string · header · required

Oauth 2.0 authentication

Path Parameters

invoice_id · string · required

The ID of the draft invoice to delete.

Maximum string length: 2147483647

Pattern: ^.*$

Body

application/json

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

The configuration for a QR code.

width · integer · default: 500

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

Required range: 150 <= x <= 500

height · integer · default: 500

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

Required range: 150 <= x <= 500

action · string · default: pay

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

Maximum string length: 7

Pattern: ^(pay|details)$

Response

200

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the QR code as a PNG image.