- HTTP request
- Request body
- Response body
- GetRedirectPaymentStatusResponse
- RedirectPaymentResult
- ChargeExceedsTransactionLimit
- ChargeUnderLimit
- AccountDoesNotSupportCurrency
- UserExitedPaymentFlow
- RiskDeclined
- CaptureRequestExpired
- OtpNotMatched
Get completion details about a specific redirect payment. If the user never redirected back to Google or there was a problem with the redirect, this API will be called to obtain the final result of a payment.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.ErrorResponse
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "ak31kzZk3l19",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "InvisiRedirectPaymentUSA_USD"
},
"redirectRequestId": "cmVxdWVzdDE"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": "1481899949611"
}
},
"result": {
"success": {}
},
"formOfPayment": {
"issuerId": {
"value": "123ABC"
}
}
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/v1/payment-integrator-redirect/getRedirectPaymentStatus
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requestHeader": {
object ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
redirect |
REQUIRED: The This is a string that has a max length of 100 characters, and contains only the characters "a-z", "A-Z", "0-9", ":", "-", and "_". |
Response body
This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse
, consult the ErrorResponse
object and HTTP status codes documentation.
Possible response messages | |
---|---|
HTTP 200 Status |
|
HTTP 4XX / 5XX Status |
|
GetRedirectPaymentStatusResponse
Response object for the redirect-fop-v1.getRedirectPaymentStatus
method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this redirect payment. |
form |
REQUIRED: The form of payment that the user selected for this payment. If the user made no choice or it does not apply, this should be set to |
RedirectPaymentResult
Result details of the redirect payment.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field result . The result of the redirect payment. The message specifies if this payment was successful, declined, or pending. result can be only one of the following: |
|
success |
Successful redirect payment, deliver the goods. |
pending |
Payment is pending a final answer. This is a non-terminal state to indicate the redirect payment was inconclusive and will resolve to be a Depending on the Google product being purchased, if it takes too long for the integrator to tell Google the payment was successful, the payment may be considered canceled due to the user dropping out of session. A payment that is late in being marked successful (for some products) will immediately be refunded after the payment was reported as A |
charge |
This redirect payment request |
charge |
This redirect payment request |
insufficient |
This account does not have sufficient funds to guarantee this redirect payment. |
account |
This account does not support the requested currency. |
user |
User canceled the whole payment attempt. At any point in the payment flow, the user performed an action that canceled the payment. This should be used only when the payment will not complete in the future. |
risk |
The transaction was declined due to a risk check done by the integrator. This does not cause the user's instrument to be closed at Google. |
capture |
It took too long for the integrator to capture the user's funds. Google will treat this decline as a final state, so the integrator must ensure that the user's funds do not get captured later or that the user gets automatically refunded if the capture ended up succeeding. |
otp |
OTP did not match what the integrator sent. |
declined |
This decline code should never be used in steady-state. It is meant as a temporary catch-all code to use when the integrator encounters an unknown decline code from the underlying issuer of the user's instrument. This result code can be used while the integrator determines a more appropriate result code to use or negotiates the addition of a new result code to this specification. Importantly, this decline code is very much a real decline. It is a permanent decline as far as Google is concerned. If the integrator returns this, it is up to them to track down what the issuer's code really means and refund the user if it turns out the code actually meant |
ChargeExceedsTransactionLimit
This payment request's amount
exceeds per-transaction limit. If this code is used populate the transactionLimit field for user messaging purposes.
JSON representation |
---|
{ "rawResult": { object ( |
Fields | |
---|---|
raw |
OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the |
Union field limit . REQUIRED: The per-transaction limit which was exceeded by this transaction. limit can be only one of the following: |
|
transaction |
REQUIRED: This is the maximum amount the user could spend on a transaction. The |
ChargeUnderLimit
This request's amount
does not meet the minimum transaction amount.
JSON representation |
---|
{ "rawResult": { object ( |
Fields | |
---|---|
raw |
OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the |
minimum |
OPTIONAL: This is the minimum amount the user could spend on a transaction. Note: this field will transition to REQUIRED in a future version of the API. |
AccountDoesNotSupportCurrency
This account does not support the requested currency.
JSON representation |
---|
{
"rawResult": {
object ( |
Fields | |
---|---|
raw |
OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the |
UserExitedPaymentFlow
User canceled the whole payment attempt.
JSON representation |
---|
{
"rawResult": {
object ( |
Fields | |
---|---|
raw |
OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a rawcode. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the |
RiskDeclined
The transaction was declined due to a risk check on the integrator's side.
JSON representation |
---|
{
"rawResult": {
object ( |
Fields | |
---|---|
raw |
OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the |
CaptureRequestExpired
It took too long for the integrator to capture the user's funds. Google will treat this decline as a final state, so the integrator must ensure that the user's funds do not get captured later or that the user gets automatically refunded if the capture ended up succeeding.
JSON representation |
---|
{
"rawResult": {
object ( |
Fields | |
---|---|
raw |
OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a rawcode. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the |
OtpNotMatched
OTP did not match what the integrator sent.
JSON representation |
---|
{
"rawResult": {
object ( |
Fields | |
---|---|
raw |
OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the |