DisplayableReferenceNumber
Stay organized with collections
Save and categorize content based on your preferences.
This message contains a reference number for a transaction.
| JSON representation |
{
// Union field display_form can be only one of the following:
"printableString": string,
"barcodeContents": string,
"barcodeWithPrintableString": {
object (BarcodeWithPrintableString)
}
// End of list of possible types for union field display_form.
} |
| Fields |
Union field display_form. REQUIRED: Different display forms of the reference number. display_form can be only one of the following: |
printableString |
string
The string value of the reference number. Normally, this string should not contain any whitespace. When displaying this string on UI, Google may insert whitespace for better readability. There is no max length limitation. However, the user/cashier may need to type in this string. The shorter the better. Populate this field if we only need to show the reference number to the users.
|
barcodeContents |
string
The contents to encode in a barcode. Google's UIs can represent the reference number in the Code 128 format or QR code format. Other barcode formats can be supported by request. Populate this field if we only need to show a barcode to the users.
|
barcodeWithPrintableString |
object (BarcodeWithPrintableString)
Populate this field if we need to show both the reference number and a barcode to the users.
|
BarcodeWithPrintableString
This message contains a printable string and a barcode contents for the reference number.
| JSON representation |
{
"printableString": string,
"barcodeContents": string
} |
| Fields |
printableString |
string
REQUIRED The string value of the reference number. Normally, this string should not contain any whitespace. When displaying this string on UI, Google may insert whitespace for better readability. There is no max length limitation. However, the user/cashier may need to type in this string. The shorter the better.
|
barcodeContents |
string
REQUIRED The contents to encode in a barcode. Google's UIs can represent the reference number in the Code 128 format or QR code format. Other barcode formats can be supported by request.
|
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-29 UTC."],[],[],null,["# DisplayableReferenceNumber\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [BarcodeWithPrintableString](#BarcodeWithPrintableString)\n - [JSON representation](#BarcodeWithPrintableString.SCHEMA_REPRESENTATION)\n\nThis message contains a reference number for a transaction.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // Union field `display_form` can be only one of the following: \"printableString\": string, \"barcodeContents\": string, \"barcodeWithPrintableString\": { object (/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/DisplayableReferenceNumber#BarcodeWithPrintableString) } // End of list of possible types for union field `display_form`. } ``` |\n\n| Fields ||\n|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Union field `display_form`. **REQUIRED** : Different display forms of the reference number. `display_form` can be only one of the following: ||\n| `printableString` | `string` The string value of the reference number. Normally, this string should not contain any whitespace. When displaying this string on UI, Google may insert whitespace for better readability. There is no max length limitation. However, the user/cashier may need to type in this string. The shorter the better. Populate this field if we only need to show the reference number to the users. |\n| `barcodeContents` | `string` The contents to encode in a barcode. Google's UIs can represent the reference number in the Code 128 format or QR code format. Other barcode formats can be supported by request. Populate this field if we only need to show a barcode to the users. |\n| `barcodeWithPrintableString` | `object (`[BarcodeWithPrintableString](/pay/refundable-one-time-payment-code-v1/payment-integrator-refundable-one-time-payment-code-api/DisplayableReferenceNumber#BarcodeWithPrintableString)`)` Populate this field if we need to show both the reference number and a barcode to the users. |\n\nBarcodeWithPrintableString\n--------------------------\n\nThis message contains a printable string and a barcode contents for the reference number.\n\n| JSON representation |\n|------------------------------------------------------------------|\n| ``` { \"printableString\": string, \"barcodeContents\": string } ``` |\n\n| Fields ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `printableString` | `string` **REQUIRED** The string value of the reference number. Normally, this string should not contain any whitespace. When displaying this string on UI, Google may insert whitespace for better readability. There is no max length limitation. However, the user/cashier may need to type in this string. The shorter the better. |\n| `barcodeContents` | `string` **REQUIRED** The contents to encode in a barcode. Google's UIs can represent the reference number in the Code 128 format or QR code format. Other barcode formats can be supported by request. |"]]