Method: getDisburseTransactionStatus

This method fetches the status of a disburse transaction.

An example request looks like:


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

An example response looks like:


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

HTTP request

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

Request body

The request body contains data with the following structure:

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

object (RequestHeader)

REQUIRED: Common header for all requests.
disburseRequestId

string

REQUIRED: The requestId of the original disburse transaction.
paymentIntegratorAccountId

string

REQUIRED: The payment integrator account identifier that identifies the caller and associated contractual constraints for this interaction.

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 (GetDisburseTransactionStatusResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)

GetDisburseTransactionStatusResponse

Response object for banking-fop-v2.getDisburseTransactionStatus.

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

  // Union field transaction_status can be only one of the following:
  "disburseResult": {
    object (DisburseResult)
  },
  "transactionDoesNotExist": {
    object (Empty)
  },
  "resultNotKnownYet": {
    object (TransactionResultNotKnownYet)
  }
  // End of list of possible types for union field transaction_status.
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (GetTransactionStatusResult)

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:
disburseResult

object (DisburseResult)

The result of the disburse transaction whose status is looked up.
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.