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-27 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-27 UTC."],[[["\u003cp\u003eThis document outlines the header object structure required for all requests sent to the server.\u003c/p\u003e\n"],["\u003cp\u003eThe header object includes \u003ccode\u003erequestId\u003c/code\u003e, \u003ccode\u003erequestTimestamp\u003c/code\u003e, \u003ccode\u003eprotocolVersion\u003c/code\u003e, and \u003ccode\u003epaymentIntegratorAccountId\u003c/code\u003e fields, all of which are mandatory.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erequestId\u003c/code\u003e is a unique identifier, \u003ccode\u003erequestTimestamp\u003c/code\u003e helps in verifying the request's timeliness, \u003ccode\u003eprotocolVersion\u003c/code\u003e specifies the request's version, and \u003ccode\u003epaymentIntegratorAccountId\u003c/code\u003e identifies the specific account.\u003c/p\u003e\n"],["\u003cp\u003eEach field has specific requirements, such as allowed characters and data types, that must be adhered to for successful communication.\u003c/p\u003e\n"]]],["Requests to the server include a header object with specific fields. The `requestId` is a unique string identifier (max 100 characters). `requestTimestamp` is a timestamp, verified to be within ±60s of the current time. `protocolVersion` indicates the request version. `paymentIntegratorAccountId` identifies a unique contractual account. All fields are required for each request and follow the JSON format.\n"],null,["- [JSON representation](#SCHEMA_REPRESENTATION)\n\nHeader object that is defined on all requests sent to the server.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestId\": string, \"requestTimestamp\": { object (/pay/partner-user-account-linking-v1/payment-integrator-partner-user-account-linking-api/Timestamp) }, \"protocolVersion\": { object (/pay/partner-user-account-linking-v1/payment-integrator-partner-user-account-linking-api/Version) }, \"paymentIntegratorAccountId\": string } ``` |\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` | `object (`[Timestamp](/pay/partner-user-account-linking-v1/payment-integrator-partner-user-account-linking-api/Timestamp)`)` **REQUIRED**: Timestamp of this request. The receiver must verify that this timestamp is ± 60s of 'now', and reject the request if it is not. This request timestamp is not idempotent upon retries. |\n| `protocolVersion` | `object (`[Version](/pay/partner-user-account-linking-v1/payment-integrator-partner-user-account-linking-api/Version)`)` **REQUIRED**: The version of this request. |\n| `paymentIntegratorAccountId` | `string` **REQUIRED**: Identifies a unique account with contractual constraints. |"]]