Response
Stay organized with collections
Save and categorize content based on your preferences.
Object sent during authentication response.
Here's an example of a clear text JSON response:
{
"associationId": "88ydEE-ioiwe==",
"requestId": "375dhjf9-Uydd="
}
The AuthenticationResponse
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 AuthenticationRequest
must be passed through the following functions:
Base64UrlEncode(
PGPSignAndEncrypt(
{
"associationId": "88ydEE-ioiwe==",
"requestId": "375dhjf9-Uydd="
}
)
)
or
Base64UrlEncode(
JWSignAndEncrypt(
{
"associationId": "88ydEE-ioiwe==",
"requestId": "375dhjf9-Uydd="
}
)
)
JSON representation |
{
"associationId": string,
"requestId": string,
"authenticationResult": {
object (AuthenticationResult )
}
} |
Fields |
associationId |
string
OPTIONAL: Reflected back by the payment integrator to Google. This allows Google to check that the associationId passed back is the same associationId passed in. This is required if it is present on the request.
|
requestId |
string
REQUIRED: Reflected back by the payment integrator to Google. This allows Google to prevent replay attacks.
|
authenticationResult |
object (AuthenticationResult )
OPTIONAL: The result of the authentication. For flows where there is no subsequent call to the Payment Integrator after the authentication has taken place, the result must be included in the response to ensure the integrity of the result.
|
AuthenticationResult
The result of the authentication.
JSON representation |
{
// Union field result can be only one of the following:
"success": {
object (Empty )
},
"cancelled": {
object (Empty )
},
"fatalError": {
object (Empty )
}
// End of list of possible types for union field result .
} |
Fields |
Union field result . REQUIRED: The result of the authentication. result can be only one of the following: |
success |
object (Empty )
Authentication was successful.
|
cancelled |
object (Empty )
User canceled the flow manually and the flow should be aborted.
|
fatalError |
object (Empty )
Authentication failed for a fatal reason and the flow should be aborted.
|
Empty
This type has no fields.
This object is used for extensibility because booleans and enumerations often need to be extended with extra data. The implementer uses it to determine presence. The enumeration this represents may be extended to contain data in future versions.
The JSON representation for Empty
is empty JSON object {}
.
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\u003eAuthenticationResponse\u003c/code\u003e object is sent during the authentication response and contains associationId, requestId, and authenticationResult.\u003c/p\u003e\n"],["\u003cp\u003eThe response is encrypted, signed (using PGP or JWE+JWS), and then encoded with web-safe base64.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAuthenticationResult\u003c/code\u003e indicates the authentication status with possible values: \u003ccode\u003esuccess\u003c/code\u003e, \u003ccode\u003ecancelled\u003c/code\u003e, or \u003ccode\u003efatalError\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eEmpty\u003c/code\u003e is a placeholder object used for extensibility and has no fields, represented by \u003ccode\u003e{}\u003c/code\u003e in JSON.\u003c/p\u003e\n"]]],["The core content describes the `AuthenticationResponse` object, which is encrypted, signed, and Base64UrlEncoded. It includes `associationId` (optional), and `requestId` (required) for replay attack prevention. It must also contain the `authenticationResult`, which includes one of three statuses: `success`, `cancelled`, or `fatalError`. Each status is represented by an `Empty` object, indicating success, user cancellation, or fatal failure of authentication. `Empty` is an extensible object.\n"],null,["# Response\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [AuthenticationResult](#AuthenticationResult)\n - [JSON representation](#AuthenticationResult.SCHEMA_REPRESENTATION)\n- [Empty](#Empty)\n\nObject sent during authentication response.\n\nHere's an example of a clear text JSON response: \n\n\n {\n \"associationId\": \"88ydEE-ioiwe==\",\n \"requestId\": \"375dhjf9-Uydd=\"\n }\n\nThe `AuthenticationResponse` 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 `AuthenticationRequest` must be passed through the following functions: \n\n Base64UrlEncode(\n PGPSignAndEncrypt(\n {\n \"associationId\": \"88ydEE-ioiwe==\",\n \"requestId\": \"375dhjf9-Uydd=\"\n }\n )\n )\n\nor \n\n Base64UrlEncode(\n JWSignAndEncrypt(\n {\n \"associationId\": \"88ydEE-ioiwe==\",\n \"requestId\": \"375dhjf9-Uydd=\"\n }\n )\n )\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"associationId\": string, \"requestId\": string, \"authenticationResult\": { object (/pay/banking-fop-v2/payment-integrator-banking-fop-api/Response#AuthenticationResult) } } ``` |\n\n| Fields ||\n|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `associationId` | `string` **OPTIONAL**: Reflected back by the payment integrator to Google. This allows Google to check that the associationId passed back is the same associationId passed in. This is required if it is present on the request. |\n| `requestId` | `string` **REQUIRED**: Reflected back by the payment integrator to Google. This allows Google to prevent replay attacks. |\n| `authenticationResult` | `object (`[AuthenticationResult](/pay/banking-fop-v2/payment-integrator-banking-fop-api/Response#AuthenticationResult)`)` **OPTIONAL**: The result of the authentication. For flows where there is no subsequent call to the Payment Integrator after the authentication has taken place, the result must be included in the response to ensure the integrity of the result. |\n\nAuthenticationResult\n--------------------\n\nThe result of the authentication.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // Union field `result` can be only one of the following: \"success\": { object (/pay/banking-fop-v2/payment-integrator-banking-fop-api/Response#Empty) }, \"cancelled\": { object (/pay/banking-fop-v2/payment-integrator-banking-fop-api/Response#Empty) }, \"fatalError\": { object (/pay/banking-fop-v2/payment-integrator-banking-fop-api/Response#Empty) } // End of list of possible types for union field `result`. } ``` |\n\n| Fields ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Union field `result`. **REQUIRED** : The result of the authentication. `result` can be only one of the following: ||\n| `success` | `object (`[Empty](/pay/banking-fop-v2/payment-integrator-banking-fop-api/Response#Empty)`)` Authentication was successful. |\n| `cancelled` | `object (`[Empty](/pay/banking-fop-v2/payment-integrator-banking-fop-api/Response#Empty)`)` User canceled the flow manually and the flow should be aborted. |\n| `fatalError` | `object (`[Empty](/pay/banking-fop-v2/payment-integrator-banking-fop-api/Response#Empty)`)` Authentication failed for a fatal reason and the flow should be aborted. |\n\nEmpty\n-----\n\nThis type has no fields.\nThis object is used for extensibility because booleans and enumerations often need to be extended with extra data. The implementer uses it to determine presence. The enumeration this represents may be extended to contain data in future versions.\n\nThe JSON representation for `Empty` is empty JSON object `{}`."]]