- HTTP request
- Request body
- Response body
- GetPayeeProxyDisplayInfoResponse
- GetPayeeProxyDisplayInfoResult
- PayeeProxyDisplayInfoSuccess
- PayeeProxyDisplayInfo
- PayeeProxyDisplayInfoFailure
- PayeeProxyDisplayInfoFailureReason
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 ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
proxy |
REQUIRED: The proxy key for which the display information is being requested. |
association |
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 |
|
HTTP 4XX / 5XX Status |
|
GetPayeeProxyDisplayInfoResponse
Response object for the banking-fop-v2.getPayeeProxyDisplayInfo method
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
display |
REQUIRED: Success/failure result of GetPayeeProxyDisplayInfoResponse. |
GetPayeeProxyDisplayInfoResult
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
success |
The display info was found for the PayeeProxyKey. |
failure |
The display info lookup failed. |
PayeeProxyDisplayInfoSuccess
Message that contains the details of a successful display information query.
JSON representation |
---|
{
"displayInfo": {
object ( |
Fields | |
---|---|
display |
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 |
Fields | |
---|---|
Union field
|
|
display |
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 ( |
Fields | |
---|---|
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. |