Method: getTransferFundsTransactionStatus

  • This method retrieves the status of a previously initiated banking-fop-v2.transferFunds transaction using its unique transferFundsRequestId.

  • The request body includes the requestHeader for authentication and the transferFundsRequestId for identifying the target transaction.

  • The response provides either the transaction status details, a transactionDoesNotExist error if not found, or a resultNotKnownYet status.

  • Possible HTTP responses include a 200 status with transaction details or a 4XX/5XX error with an ErrorResponse object.

  • The GetTransferFundsTransactionStatusResponse object contains the responseHeader, result, and a union field transaction_status detailing the specific transaction outcome.

This method fetches the status of a banking-fop-v2.transferFunds transaction.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
    "requestTimestamp": {
      "epochMillis": "1502220196077"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "transferFundsRequestId":"bnAxdWTydDX=="
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1481900013178"
    }
  },
  "result": { "success": {} },
  "transferFundsResult": { "success": {} }
}

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/v2/getTransferFundsTransactionStatus

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "transferFundsRequestId": string
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.
transferFundsRequestId

string

REQUIRED: The requestId of the original banking-fop-v2.transferFunds 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

object (GetTransferFundsTransactionStatusResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)
End of mutually exclusive fields.

GetTransferFundsTransactionStatusResponse

Response object for banking-fop-v2.getTransferFundsTransactionStatus.

JSON representation 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (GetTransactionStatusResult)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "transferFundsResult": {
    object (TransferFundsResult)
  },
  "transactionDoesNotExist": {
    object (Empty)
  },
  "resultNotKnownYet": {
    object (TransactionResultNotKnownYet)
  }
  // End of mutually exclusive fields.
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (GetTransactionStatusResult)

REQUIRED: Result of this GetTransactionStatus call.
REQUIRED: The actual status of the transaction which is looked up. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
transferFundsResult

object (TransferFundsResult)

Result of the FundsTransfer operation.
transactionDoesNotExist

object (Empty)

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

object (TransactionResultNotKnownYet)

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.
End of mutually exclusive fields.