Method: getTransferStatus

Gets the status of a transfer for a QR code payment.

The response to this message will return the result of the payment attempt.

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": "qierozie12346",
    "requestTimestamp": {
      "epochMillis": "1481899949606"
    },
    "paymentIntegratorAccountId": "QrPay_USD"
  },
  "transferRequestId": "qierozie12345"
}

An example success response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1481899949611"
    }
  },
  "result": {
    "success": {
      "success": {
        "referenceLabel": "reference-label",
        "transactionTimestamp": {
          "epochMillis": "123456789"
        },
        "merchantId": "0000000037451839",
        "acquirerId": "6449028866",
        "terminalId": "FC000106",
        "authorizationCode": "120059",
        "hostNsu": "001837",
        "terminalNsu": "110720",
        "authorizationCode": "1228899800999",
        "cardScheme": "VISA"
      }
    }
  }
}

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/cards-qr-v1/getTransferStatus

Request body

The request body contains data with the following structure:

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

object (RequestHeader)

REQUIRED: Common header for all requests.
transferRequestId

string

REQUIRED: The unique identifier of the transfer request.

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.

JSON representation 
{

  // Union field response_type can be only one of the following:
  "response": {
    object (GetTransferStatusResponse)
  },
  "errorResponse": {
    object (ErrorResponse)
  }
  // End of list of possible types for union field response_type.
}
Possible response messages
HTTP 200 Status

object (GetTransferStatusResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)

GetTransferStatusResponse

The response body object for the cards-qr-v1.getTransferStatus method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (GetTransferStatusResult)

REQUIRED: Result of this cards-qr-v1.getTransferStatus call.

GetTransferStatusResult

Result codes for cards-qr-v1.getTransferStatus. This indicates the status of the lookup operation and not the actual transfer. If the transfer look up failed due to some internal error, the partner should return a non 200 Http error code.

JSON representation 
{

  // Union field result can be only one of the following:
  "success": {
    object (TransferResult)
  },
  "transferDoesNotExist": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Fields
Union field result. REQUIRED: The transfer status result. result can be only one of the following:
success

object (TransferResult)

Success. Returns the result of the transfer operation.
transferDoesNotExist

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.