AI-generated Key Takeaways
-
This method retrieves the status of a previously initiated
transferFunds
transaction using thetransferFundsRequestId
. -
The request body requires a
requestHeader
and the originaltransferFundsRequestId
. -
The response provides a
responseHeader
, aresult
indicating the lookup status, and details about the transaction status (transferFundsResult
,transactionDoesNotExist
, orresultNotKnownYet
). -
Potential HTTP response statuses include 200 for success and 4XX/5XX for errors, with specific response bodies for each scenario.
-
The
GetTransactionStatusResult
indicates the success of the transaction lookup operation, separate from the actual transaction status.
- HTTP request
- Request body
- Response body
- GetTransferFundsTransactionStatusResponse
- GetTransactionStatusResult
This method fetches the status of a e-wallets-v1.transferFunds transaction.
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 0,
"revision": 0
},
"requestId": "liUrreQY233839dfFFb24gaQM",
"requestTimestamp": "1502220434778"
},
"transferFundsRequestId":"bnAxdWTydDX==",
"paymentIntegratorAccountId": "InvisiCash"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1481900013178"
},
"result": { "success": {} },
"transferFundsResult": { "success": {} }
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/e-wallets-v1/getTransferFundsTransactionStatus
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requestHeader": {
object ( |
Fields | |
---|---|
requestHeader |
REQUIRED: Common header for all requests. |
transferFundsRequestId |
REQUIRED: The requestId of the original e-wallets-v1.transferFunds transaction. |
paymentIntegratorAccountId |
OPTIONAL: This is the payment integrator account identifier that identifies contractual constraints around this transaction. |
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 |
|
GetTransferFundsTransactionStatusResponse
Response object for e-wallets-v1.getTransferFundsTransactionStatus.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
responseHeader |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this GetTransactionStatus call. |
Union field transaction_status . REQUIRED: The actual status of the transaction which is looked up. transaction_status can be only one of the following: |
|
transferFundsResult |
Result of the FundsTransfer operation. |
transactionDoesNotExist |
The transaction was not found in the system. This can happen if the call from Google to partner got dropped and the partner never received the original transaction. Now when Google tries to lookup the status, partner should return this error code to indicate that the transaction doesn't exist in the system. Google should mark the transaction as failed in that case. It is different than a Http 404 where the URL of GetTransactionStatus was not found in which case Google can't update the status of the transaction. |
resultNotKnownYet |
Captures the scenario where the integrator itself doesn't have a definite status, maybe because they have not received it from the underlying payment network. |
GetTransactionStatusResult
Result codes for GetTransactionStatus. This indicates the status of the lookup operation and not the actual transaction. If the transaction look up failed due to some internal error, the partner should return a non 200 Http error code.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field result . REQUIRED: The result of the GetTransactionStatus call. result can be only one of the following: |
|
success |
Successful lookup. |