Method: getPayeeProxyRegistrationStatus

Checks whether or not a mapping to a Payee has been registered for the specified proxy key.

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"
    }
  },
  "registrationStatus": "REGISTERED"
}

HTTP request

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

Request body

The request body contains data with the following structure:

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

object (RequestHeader)

REQUIRED: Common header for all requests.
proxyKey

object (PayeeProxyKey)

REQUIRED: The proxy key for which the registration status is being queried.

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

object (ErrorResponse)

GetPayeeProxyRegistrationStatusResponse

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

JSON representation 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "registrationStatus": enum (PayeeProxyRegistrationStatus)
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.
registrationStatus

enum (PayeeProxyRegistrationStatus)

REQUIRED: Registration status of the Proxy Key.

PayeeProxyRegistrationStatus

Codes that define the registration statuses.

Enums
PAYEE_PROXY_REGISTRATION_STATUS_UNSPECIFIED Do not ever set this default value!
REGISTERED The proxy key is registered.
NOT_REGISTERED The proxy key is not registered.