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 and metadata.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erequestId\u003c/code\u003e, \u003ccode\u003erequestTimestamp\u003c/code\u003e, \u003ccode\u003eprotocolVersion\u003c/code\u003e, and \u003ccode\u003epaymentIntegratorAccountId\u003c/code\u003e are required fields within the Header object.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erequestId\u003c/code\u003e is a unique identifier for each request, limited to 100 characters with specific allowed characters.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erequestTimestamp\u003c/code\u003e must be within 60 seconds of the current time and is not idempotent for retries.\u003c/p\u003e\n"],["\u003cp\u003eThe receiver should validate the timestamp and reject requests outside the allowed timeframe.\u003c/p\u003e\n"]]],["Requests to the server include a header object with four fields: `requestId`, a unique string identifier with specific character limits; `requestTimestamp`, a timestamp that must be within ±60 seconds of the current time; `protocolVersion`, specifying the request's version; and `paymentIntegratorAccountId`, a string identifying a unique account. Each of these fields is required for every request. `requestTimestamp` should be considered as not idempotent upon retries.\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/banking-fop-v2/payment-integrator-banking-fop-api/Timestamp) }, \"protocolVersion\": { object (/pay/banking-fop-v2/payment-integrator-banking-fop-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/banking-fop-v2/payment-integrator-banking-fop-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/banking-fop-v2/payment-integrator-banking-fop-api/Version)`)` **REQUIRED**: The version of this request. |\n| `paymentIntegratorAccountId` | `string` **REQUIRED**: Identifies a unique account with contractual constraints. |"]]