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 Header object is included in all server requests and contains key identifiers like \u003ccode\u003erequestId\u003c/code\u003e, \u003ccode\u003erequestTimestamp\u003c/code\u003e, \u003ccode\u003eprotocolVersion\u003c/code\u003e, and \u003ccode\u003epaymentIntegratorAccountId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erequestId\u003c/code\u003e is a unique identifier for each request with specific character limitations, while \u003ccode\u003erequestTimestamp\u003c/code\u003e helps verify request timing within a 60-second window.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eprotocolVersion\u003c/code\u003e indicates the request version, and \u003ccode\u003epaymentIntegratorAccountId\u003c/code\u003e identifies the specific account subject to contractual agreements.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erequestTimestamp\u003c/code\u003e is crucial for security as the receiver should reject requests with timestamps outside the acceptable timeframe, and it's not idempotent upon retries, meaning its value changes with each attempt.\u003c/p\u003e\n"]]],["Requests to the server must include a header object. This header contains: a unique `requestId` string (max 100 characters, alphanumeric and \":\", \"-\", \"_\"), a `requestTimestamp` object (verified within ± 60s of 'now'), a `protocolVersion` object, and a `paymentIntegratorAccountId` string, identifying a unique, contractually constrained account. All four fields are mandatory. The header data is included in JSON format.\n"],null,["# RequestHeader\n\n- [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/virtual-cards-v1/payment-integrator-virtual-cards-api/Timestamp) }, \"protocolVersion\": { object (/pay/virtual-cards-v1/payment-integrator-virtual-cards-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/virtual-cards-v1/payment-integrator-virtual-cards-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/virtual-cards-v1/payment-integrator-virtual-cards-api/Version)`)` **REQUIRED**: The version of this request. |\n| `paymentIntegratorAccountId` | `string` **REQUIRED**: Identifies a unique account with contractual constraints. |"]]