RequestHeader
Stay organized with collections
Save and categorize content based on your preferences.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 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-02-28 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eRequestHeader\u003c/code\u003e object is included in all server requests and contains identifying information like request ID, timestamp, user locale (deprecated), and protocol version.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erequestId\u003c/code\u003e is a unique identifier for each request with a maximum length of 100 characters, using only alphanumeric characters, colon, hyphen, and underscore.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erequestTimestamp\u003c/code\u003e is crucial for request validation and should be within 60 seconds of the current time.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eprotocolVersion\u003c/code\u003e follows a structured format (major.minor.revision) indicating the compatibility level of the request.\u003c/p\u003e\n"],["\u003cp\u003eIntegrators must handle requests with the same major version but should be aware that minor and revision changes might occur frequently.\u003c/p\u003e\n"]]],["Requests to the server include a header object with these key elements: `requestId`, a unique string identifier; `requestTimestamp`, a timestamp in milliseconds, validated for accuracy within 60 seconds; and `protocolVersion`, an object containing `major`, `minor`, and `revision` integer values to manage compatibility. The `userLocale` field, once intended for language and region, is now deprecated. Each request requires unique IDs and valid timestamps. The `version` ensures compatibility with major version numbers.\n"],null,["# RequestHeader\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [Version](#Version)\n - [JSON representation](#Version.SCHEMA_REPRESENTATION)\n\nHeader object that is defined on all requests sent to the server.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestId\": string, \"requestTimestamp\": string, \"userLocale\": string, \"protocolVersion\": { object (/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/RequestHeader#Version) } } ``` |\n\n| Fields ||\n|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestId` | `string` **REQUIRED**: Unique identifier of this request. This is a string that has a max length of 100 characters, and contains only the characters \"a-z\", \"A-Z\", \"0-9\", \":\", \"-\", and \"_\". |\n| `requestTimestamp` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` **REQUIRED**: Timestamp of this request represented as milliseconds since epoch. The receiver should verify that this timestamp is ± 60s of 'now'. This request timestamp is not idempotent upon retries. |\n| `userLocale` **(deprecated)** | `string` | This was never implemented and is being removed in future versions. This field is ignored. **DEPRECATED** : A two- or three-letter ISO 639-2 Alpha 3 language code optionally followed by a hyphen and an ISO 3166-1 Alpha-2 country code, e.g.'pt', 'pt-BR', 'fil', or 'fil-PH'. Use this to help drive the `userMessage` fields in the response. |\n| `protocolVersion` | `object (`[Version](/pay/one-time-payment-code-v1/payment-integrator-one-time-payment-code-api/RequestHeader#Version)`)` **REQUIRED**: The version of this request. |\n\nVersion\n-------\n\nVersion object which is a structured form of the classic `a.b.c` version structure. Major versions of the same number are guaranteed to be compatible. Note that minor and revisions can change frequently and without notice. The integrator must support all requests for the same major version.\n\n| JSON representation |\n|---------------------------------------------------------------------|\n| ``` { \"major\": integer, \"minor\": integer, \"revision\": integer } ``` |\n\n| Fields ||\n|------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `major` | `integer` **REQUIRED**: Major version. This is marked for compatibility requests with different versions are not guaranteed to be compatible. |\n| `minor` | `integer` **REQUIRED**: Minor version. This denotes significant bug fixes. |\n| `revision` | `integer` **REQUIRED**: Minor version. This denotes minor bug fixes. |"]]