Overview
This method will generate QR code to receipt/return receipt. It will use receipt’s key fields to generate the QR code.
Note!
• It accepts single receipt json as a payload and it should contain UUID value in it.
• It will gives an error if the structure of the receipt is incorrect.
Signature
Signature:
GenerateQrCodeResponseDto response = await _toolkitHandler.GenerateQrCode(inputReceiptJsonWithUUID)
public class GenerateQrCodeResponseDto : BaseResponseDto
{
public string QrCode { get; set; } = null!;
public string QrCodeImageBase64 { get; set; } = null!;
}
public class BaseResponseDto
{
public string? CorrelationId { get; set; }
public string? Target { get; set; }
public string? Code { get; set; }
public string? Message { get; set; }
public object? Details { get; set; }
}
Inputs
This request accepts a string input and it should be receipt json string with UUID value:
| Input parameter | Type | Description | Value example |
|---|---|---|---|
| receipt/return receipt json | String | Receipt json with UUID |
Outputs
It will generate QR code url and QR code image as base 64 format and given it as a response.
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| QrCode | String | receipt output QR code. | |
| QrCodeImageBase64 | String | receipt output QR code image base 64. | |
| CorrelationId | String | CorrelationId is a unique number for the request. It has nothing to do with the receipt. It gets a value only in case of an error. | |
| Target | String | Output target. | |
| Code | String | Code is an error code, and it’s only sent if there is an error. | 404 / 500 etc., |
| Message | String | Error message. | |
| Details | String | Details of the error. |