Method: getPayeeProxyDisplayInfo

Returns the display data that has been registered for the specified proxy key (e.g. display name to be shown before payment)

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
    "requestTimestamp": {
      "epochMillis": "1502220196077"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "proxyKey": {
    "phoneNumber": "+001234567890"
  }
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1481900013178"
    }
  },
  "displayInfoResult": {
    "success": {
      "displayInfo": {
        "displayName": "Sam Payee"
      }
    }
  }
}

HTTP request

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "proxyKey": {
    object (PayeeProxyKey)
  },
  "associationId": string
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.
proxyKey

object (PayeeProxyKey)

REQUIRED: The proxy key for which the display information is being requested.
associationId

string

OPTIONAL: The ID that represents the association between a customer's Google Account and a customer's account with the vendor. Only present if the request is initiated by a user in-session.

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

object (ErrorResponse)

GetPayeeProxyDisplayInfoResponse

Response object for the banking-fop-v2.getPayeeProxyDisplayInfo method

JSON representation 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "displayInfoResult": {
    object (GetPayeeProxyDisplayInfoResult)
  }
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.
displayInfoResult

object (GetPayeeProxyDisplayInfoResult)

REQUIRED: Success/failure result of GetPayeeProxyDisplayInfoResponse.

GetPayeeProxyDisplayInfoResult

The result codes for the banking-fop-v2.getPayeeProxyDisplayInfo call.

JSON representation 
{

  // Union field result can be only one of the following:
  "success": {
    object (PayeeProxyDisplayInfoSuccess)
  },
  "failure": {
    object (PayeeProxyDisplayInfoFailure)
  }
  // End of list of possible types for union field result.
}
Fields
Union field result. REQUIRED: The result of the GetPayeeProxyDisplayInfo call. result can be only one of the following:
success

object (PayeeProxyDisplayInfoSuccess)

The display info was found for the PayeeProxyKey.
failure

object (PayeeProxyDisplayInfoFailure)

The display info lookup failed.

PayeeProxyDisplayInfoSuccess

Message that contains the details of a successful display information query.

JSON representation 
{
  "displayInfo": {
    object (PayeeProxyDisplayInfo)
  }
}
Fields
displayInfo

object (PayeeProxyDisplayInfo)

REQUIRED: Display information for the Proxy Key.

PayeeProxyDisplayInfo

Data that is meant for display and has been registered for a given PayeeProxyKey.

JSON representation 
{

  // Union field display_info can be only one of the following:
  "displayName": string
  // End of list of possible types for union field display_info.
}
Fields
Union field display_info. REQUIRED: Display information for the Proxy Key. display_info can be only one of the following:
displayName

string

Name that has been registered for display with the PayeeProxy.

PayeeProxyDisplayInfoFailure

Message that contains the details of a failed display information query.

JSON representation 
{
  "failureReason": enum (PayeeProxyDisplayInfoFailureReason)
}
Fields
failureReason

enum (PayeeProxyDisplayInfoFailureReason)

REQUIRED: The reason for the failure.

PayeeProxyDisplayInfoFailureReason

Reason for a failure to lookup display information.

Enums
PAYEE_PROXY_DISPLAY_INFO_FAILURE_REASON_UNSPECIFIED Do not ever set this default value!
PROXY_KEY_NOT_REGISTERED The specified proxy key was not registered and thus no display information could be returned.