RequestHeader
Stay organized with collections
Save and categorize content based on your preferences.
Header object that is defined on all requests sent to the server.
| JSON representation |
{
"requestId": string,
"requestTimestamp": string,
"userLocale": string,
"protocolVersion": {
object (Version)
}
} |
| Fields |
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 "_".
|
requestTimestamp |
string (int64 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.
|
userLocale
(deprecated) |
string
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.
|
protocolVersion |
object (Version)
REQUIRED: The version of this request.
|
Version
Version 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.
| JSON representation |
{
"major": integer,
"minor": integer,
"revision": integer
} |
| Fields |
major |
integer
REQUIRED: Major version. This is marked for compatibility requests with different versions are not guaranteed to be compatible.
|
minor |
integer
REQUIRED: Minor version. This denotes significant bug fixes.
|
revision |
integer
REQUIRED: Minor version. This denotes minor bug fixes.
|
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-03 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 2024-09-03 UTC."],[[["\u003cp\u003eThe RequestHeader object, present in all server requests, includes crucial details like request ID, timestamp, and protocol version.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erequestId\u003c/code\u003e is a unique alphanumeric identifier, limited to 100 characters, using "a-z", "A-Z", "0-9", ":", "-", and "_".\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erequestTimestamp\u003c/code\u003e, in milliseconds since epoch, must be within ± 60 seconds of the current time for server acceptance.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eprotocolVersion\u003c/code\u003e object uses a structured format (\u003ccode\u003emajor.minor.revision\u003c/code\u003e) to ensure compatibility across major versions while acknowledging potential changes in minor and revision numbers.\u003c/p\u003e\n"],["\u003cp\u003eWhile \u003ccode\u003euserLocale\u003c/code\u003e was initially intended for language preferences, it's deprecated and no longer functional.\u003c/p\u003e\n"]]],["Requests to the server require a header object, including a `requestId` (unique string identifier), `requestTimestamp` (milliseconds since epoch, within 60s of current time), and `protocolVersion`. The `userLocale` field is deprecated and ignored. The `protocolVersion` is a structured `major.minor.revision` version number. Major versions guarantee compatibility, while minor and revision changes can happen without notice. All requests must support the same major version.\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 (/standard-payments/payment-processor-service-api/v1/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](/standard-payments/payment-processor-service-api/v1/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. |"]]