GeneratePaymentTokenRedirectResponse
Stay organized with collections
Save and categorize content based on your preferences.
Response object for the Complete Redirect flow.
Here's an example of a clear text JSON request:
{
"redirectRequestId": "cmVxdWVzdDE",
"result": {
"success": {}
}
}
The GeneratePaymentTokenRedirectResponse
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 GeneratePaymentTokenRedirectResponse
must be passed through the following functions:
Base64UrlEncode(
PGPSignAndEncrypt(
{
"redirectRequestId": "cmVxdWVzdDE",
"result": {
"success": {}
}
}
)
)
or
Base64UrlEncode(
JWSignAndEncrypt(
{
"redirectRequestId": "cmVxdWVzdDE",
"result": {
"success": {}
}
}
)
)
Fields |
redirectRequestId |
string
REQUIRED: Unique identifier of the initiating redirect 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 "_".
|
Union field redirectResult . REQUIRED: The result of the redirect payment. redirectResult can be only one of the following: |
result |
object (GeneratePaymentTokenRedirectResult)
Result of this redirect payment if it was successful, declined, or pending.
|
errorResponse |
object (GeneratePaymentTokenRedirectErrorResponse )
Details if the redirect failed because of an error. Redirect payments that receive this reply are kept open, and the integrator can later send a redirectPaymentCompleteNotification if the payment was successful or declined.
|
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-29 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-07-29 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eGeneratePaymentTokenRedirectResponse\u003c/code\u003e object provides the result of a Complete Redirect flow.\u003c/p\u003e\n"],["\u003cp\u003eThis response is encrypted, signed (using PGP or JWE+JWS), and encoded using web-safe base64.\u003c/p\u003e\n"],["\u003cp\u003eThe response contains a \u003ccode\u003eredirectRequestId\u003c/code\u003e and either a \u003ccode\u003eresult\u003c/code\u003e or \u003ccode\u003eerrorResponse\u003c/code\u003e field indicating the payment outcome.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful, declined, or pending payments will populate the \u003ccode\u003eresult\u003c/code\u003e field with details.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eerrorResponse\u003c/code\u003e field is used if the redirect failed due to an error, allowing for later updates via \u003ccode\u003eredirectPaymentCompleteNotification\u003c/code\u003e.\u003c/p\u003e\n"]]],["The core content details the structure and processing of the `GeneratePaymentTokenRedirectResponse` object, used in a redirect payment flow. This response, containing a `redirectRequestId` and either a `result` or `errorResponse`, is first signed and encrypted using PGP or JWE+JWS, and then encoded using Base64UrlEncode. The `redirectRequestId` is a unique identifier, while `result` indicates a successful, declined, or pending outcome, and `errorResponse` details any failures. The response's format is defined as a JSON structure.\n"],null,["# GeneratePaymentTokenRedirectResponse\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nResponse object for the Complete Redirect flow.\n\nHere's an example of a clear text JSON request: \n\n\n {\n \"redirectRequestId\": \"cmVxdWVzdDE\",\n \"result\": {\n \"success\": {}\n }\n }\n\nThe `GeneratePaymentTokenRedirectResponse` 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 `GeneratePaymentTokenRedirectResponse` must be passed through the following functions: \n\n Base64UrlEncode(\n PGPSignAndEncrypt(\n {\n \"redirectRequestId\": \"cmVxdWVzdDE\",\n \"result\": {\n \"success\": {}\n }\n }\n )\n )\n\nor \n\n Base64UrlEncode(\n JWSignAndEncrypt(\n {\n \"redirectRequestId\": \"cmVxdWVzdDE\",\n \"result\": {\n \"success\": {}\n }\n }\n )\n )\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"redirectRequestId\": string, // Union field `redirectResult` can be only one of the following: \"result\": { object (/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-api/getGeneratePaymentTokenRedirectStatus#GeneratePaymentTokenRedirectResult) }, \"errorResponse\": { object (/pay/redirect-payment-token-v1/google-redirect-payment-token-api/GeneratePaymentTokenRedirectErrorResponse) } // End of list of possible types for union field `redirectResult`. } ``` |\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `redirectRequestId` | `string` **REQUIRED**: Unique identifier of the initiating redirect 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| Union field `redirectResult`. **REQUIRED** : The result of the redirect payment. `redirectResult` can be only one of the following: ||\n| `result` | `object (`[GeneratePaymentTokenRedirectResult](/pay/redirect-payment-token-v1/payment-integrator-redirect-payment-token-api/getGeneratePaymentTokenRedirectStatus#GeneratePaymentTokenRedirectResult)`)` Result of this redirect payment if it was successful, declined, or pending. |\n| `errorResponse` | `object (`[GeneratePaymentTokenRedirectErrorResponse](/pay/redirect-payment-token-v1/google-redirect-payment-token-api/GeneratePaymentTokenRedirectErrorResponse)`)` Details if the redirect failed because of an error. Redirect payments that receive this reply are kept open, and the integrator can later send a `redirectPaymentCompleteNotification` if the payment was successful or declined. |"]]