Skip to navigation

Generate QR code for a link in SVG and PNG format

Path parameters

domainstringRequired

This is the domain specified when the shortUrl was registered.

guidstringRequired

The shortUrl path.

Query parameters

qrbooleanRequired
This indicates that Amex is generating a QR code.
qrLengthstringRequired
This indicates the length of the QR code.
qrWidthstringRequired
This indicates the width of the QR code.
qrEcstringRequired

This is the level of damage the QR code can suffer and still be scannable. The levels available are Q(15%), M(25%), and H(30%).

primaryColorstringRequired

This indicates the color of the QR code. The colors available are Blue and Black.

svgbooleanOptional
This is to indicate that you are generating the QR code in SVG format. QR code can also be generated in PNG format. SVG formats are better for responsive behavior due to their scalability and lack of quality degradation. An SVG QR code is great for printing at the highest quality.
brandedbooleanRequired
This will add the American Express logo in the center of the QR code.

Response

Success response.

Errors

500
Internal Server Error