TopUpRedirectRequest
Stay organized with collections
Save and categorize content based on your preferences.
Request object for the Top-Up Redirect flow.
Here's an example of a clear text JSON request:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 1,
"revision": 0
},
"requestId": "G112YZH4XPDV88J",
"requestTimestamp": "1481907920000"
},
"associationId": "LmddbXBsZSByZWZlcmVuY2UgdG9rZW4gdmFsdWU_"
}
The TopUpRedirectRequest
is encrypted and signed using PGP or JWE+JWS. Further, this value is web-safe base64
encoded. This encoding is referred to below as Base64UrlEncode
. In other words, the clear text JSON version of the TopUpRedirectRequest
must be passed through the following functions:
Base64UrlEncode(
PGPSignAndEncrypt(
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 1,
"revision": 0
},
"requestId": "G112YZH4XPDV88J",
"requestTimestamp": "1481907920000"
},
"associationId": "LmddbXBsZSByZWZlcmVuY2UgdG9rZW4gdmFsdWU_"
}
)
)
or
Base64UrlEncode(
JWSignAndEncrypt(
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 1,
"revision": 0
},
"requestId": "G112YZH4XPDV88J",
"requestTimestamp": "1481907920000"
},
"associationId": "LmddbXBsZSByZWZlcmVuY2UgdG9rZW4gdmFsdWU_"
}
)
)
JSON representation |
{
"requestHeader": {
object (RequestHeader )
},
"associationId": string,
"targetBalance": {
object (Amount )
}
} |
Fields |
associationId |
string
REQUIRED: The associationId that represents the user's account. This is public-facing ID for the user's account that was provided by Google during the associateAccount call.
|
targetBalance |
object (Amount )
OPTIONAL: The target balance to reach, in micros.
|
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 Top-Up Redirect flow uses a JSON request object that includes request header details and an association ID.\u003c/p\u003e\n"],["\u003cp\u003eThis JSON request is encrypted and signed using either PGP or JWE+JWS and then encoded using Base64UrlEncode for security.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eassociationId\u003c/code\u003e is a required field representing the user's public-facing account ID previously provided by Google.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003etargetBalance\u003c/code\u003e field can be included to specify the desired final balance in micros.\u003c/p\u003e\n"]]],["The `TopUpRedirectRequest` requires a `requestHeader` with protocol version, request ID, and timestamp, along with a mandatory `associationId` representing the user's account. An optional `targetBalance` specifies the desired balance. The request is encrypted and signed using either PGP or JWE+JWS, then encoded via Base64UrlEncode. The clear text is structured as a JSON object that is transformed.\n"],null,[]]