RedirectRequest
Stay organized with collections
Save and categorize content based on your preferences.
Request object for the Begin Redirect flow.
Here's an example of a clear text JSON request:
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "cmVxdWVzdDE",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "InvisiRedirectPaymentUSA_USD"
},
"transactionAmount": {
"amountMicros": "109900000",
"currencyCode": "INR"
},
"transactionDescription": "Play Movies",
"formOfPayment": {
"issuerId": {
"value": "123ABC"
}
}
}
The RedirectRequest
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 RedirectRequest
must be passed through the following functions:
Base64UrlEncode(
PGPSignAndEncrypt(
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "cmVxdWVzdDE",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "InvisiRedirectPaymentUSA_USD"
},
"transactionAmount": {
"amountMicros": "109900000",
"currencyCode": "INR"
},
"transactionDescription": "Play Movies",
"formOfPayment": {
"issuerId": {
"value": "123ABC"
}
}
}
)
)
or
Base64UrlEncode(
JWSignAndEncrypt(
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "cmVxdWVzdDE",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "InvisiRedirectPaymentUSA_USD"
},
"transactionAmount": {
"amountMicros": "109900000",
"currencyCode": "INR"
},
"transactionDescription": "Play Movies",
"formOfPayment": {
"issuerId": {
"value": "123ABC"
}
}
}
)
)
JSON representation |
{
"requestHeader": {
object (RequestHeader )
},
"transactionAmount": {
object (Amount )
},
"transactionDescription": string,
"formOfPayment": {
object (FormOfPayment )
}
} |
Fields |
transactionAmount |
object (Amount )
REQUIRED: The amount of the transaction.
|
transactionDescription |
string
REQUIRED: A description of the transaction that can be shown to the user.
|
formOfPayment |
object (FormOfPayment )
REQUIRED: The form of payment that the user already selected for this payment. If the user made no choice or it does not apply, this will be set to noneChosen . In the noneChosen case, the user should be redirected to the integrator's website to allow the user to select a form of payment.
|
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 Begin Redirect flow utilizes a JSON request object to initiate the process.\u003c/p\u003e\n"],["\u003cp\u003eThis JSON request is encrypted, signed (using PGP or JWE+JWS), and then base64 encoded for security.\u003c/p\u003e\n"],["\u003cp\u003eThe request object includes details like transaction amount, description, and selected form of payment.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eformOfPayment\u003c/code\u003e field indicates the user's payment choice and guides further actions, like redirecting to the integrator's site for payment selection if none is chosen.\u003c/p\u003e\n"]]],["The `RedirectRequest` initiates a redirect flow, containing transaction details and payment information. It requires a `requestHeader` with protocol version, request ID, timestamp, and account ID. The `transactionAmount` specifies the amount in micros and currency. `transactionDescription` provides a user-visible description. `formOfPayment` indicates the selected payment method. This JSON request is signed and encrypted using either PGP or JWE+JWS, then encoded with Base64UrlEncode before being submitted.\n"],null,["# RedirectRequest\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nRequest object for the Begin Redirect flow.\n\nHere's an example of a clear text JSON request: \n\n\n {\n \"requestHeader\": {\n \"protocolVersion\": {\n \"major\": 1\n },\n \"requestId\": \"cmVxdWVzdDE\",\n \"requestTimestamp\": {\n \"epochMillis\": \"1481899949606\"\n },\n \"paymentIntegratorAccountId\": \"InvisiRedirectPaymentUSA_USD\"\n },\n \"transactionAmount\": {\n \"amountMicros\": \"109900000\",\n \"currencyCode\": \"INR\"\n },\n \"transactionDescription\": \"Play Movies\",\n \"formOfPayment\": {\n \"issuerId\": {\n \"value\": \"123ABC\"\n }\n }\n }\n\nThe `RedirectRequest` 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 `RedirectRequest` must be passed through the following functions: \n\n Base64UrlEncode(\n PGPSignAndEncrypt(\n {\n \"requestHeader\": {\n \"protocolVersion\": {\n \"major\": 1\n },\n \"requestId\": \"cmVxdWVzdDE\",\n \"requestTimestamp\": {\n \"epochMillis\": \"1481899949606\"\n },\n \"paymentIntegratorAccountId\": \"InvisiRedirectPaymentUSA_USD\"\n },\n \"transactionAmount\": {\n \"amountMicros\": \"109900000\",\n \"currencyCode\": \"INR\"\n },\n \"transactionDescription\": \"Play Movies\",\n \"formOfPayment\": {\n \"issuerId\": {\n \"value\": \"123ABC\"\n }\n }\n }\n )\n )\n\nor \n\n Base64UrlEncode(\n JWSignAndEncrypt(\n {\n \"requestHeader\": {\n \"protocolVersion\": {\n \"major\": 1\n },\n \"requestId\": \"cmVxdWVzdDE\",\n \"requestTimestamp\": {\n \"epochMillis\": \"1481899949606\"\n },\n \"paymentIntegratorAccountId\": \"InvisiRedirectPaymentUSA_USD\"\n },\n \"transactionAmount\": {\n \"amountMicros\": \"109900000\",\n \"currencyCode\": \"INR\"\n },\n \"transactionDescription\": \"Play Movies\",\n \"formOfPayment\": {\n \"issuerId\": {\n \"value\": \"123ABC\"\n }\n }\n }\n )\n )\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestHeader\": { object (/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/RequestHeader) }, \"transactionAmount\": { object (/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/Amount) }, \"transactionDescription\": string, \"formOfPayment\": { object (/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/FormOfPayment) } } ``` |\n\n| Fields ||\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestHeader` | `object (`[RequestHeader](/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/RequestHeader)`)` **REQUIRED**: Common header for all requests. |\n| `transactionAmount` | `object (`[Amount](/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/Amount)`)` **REQUIRED**: The amount of the transaction. |\n| `transactionDescription` | `string` **REQUIRED**: A description of the transaction that can be shown to the user. |\n| `formOfPayment` | `object (`[FormOfPayment](/pay/redirect-fop-v1/payment-integrator-redirect-fop-api/FormOfPayment)`)` **REQUIRED** : The form of payment that the user already selected for this payment. If the user made no choice or it does not apply, this will be set to `noneChosen`. In the `noneChosen` case, the user should be redirected to the integrator's website to allow the user to select a form of payment. |"]]