Method: getPayeeProxyRegistrationStatus
Stay organized with collections
Save and categorize content based on your preferences.
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:
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
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. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eThis API checks if a Payee mapping exists for a given proxy key.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003erequestHeader\u003c/code\u003e and a \u003ccode\u003eproxyKey\u003c/code\u003e with phone number.\u003c/p\u003e\n"],["\u003cp\u003eThe response indicates the registration status as either \u003ccode\u003eREGISTERED\u003c/code\u003e or \u003ccode\u003eNOT_REGISTERED\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003ePossible response messages include a 200 status with registration details or a 4XX/5XX status with an error.\u003c/p\u003e\n"]]],["This documentation outlines how to check a Payee's proxy registration status. A `POST` request is sent to the specified URL with a `requestHeader` and a `proxyKey` in the request body. The system checks if the `proxyKey` is registered. The response body returns a `responseHeader` and a `registrationStatus`, which can be `REGISTERED` or `NOT_REGISTERED`. Unregistered `proxyKey` will result in error 4XX/5XX status. The `proxyKey` can have a `phoneNumber` in the json representation.\n"],null,["# Method: getPayeeProxyRegistrationStatus\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [GetPayeeProxyRegistrationStatusResponse](#GetPayeeProxyRegistrationStatusResponse)\n - [JSON representation](#GetPayeeProxyRegistrationStatusResponse.SCHEMA_REPRESENTATION)\n- [PayeeProxyRegistrationStatus](#PayeeProxyRegistrationStatus)\n\nChecks whether or not a mapping to a Payee has been registered for the specified proxy key.\n\nAn example request looks like: \n\n\n {\n \"requestHeader\": {\n \"protocolVersion\": {\n \"major\": 2\n },\n \"requestId\": \"bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ\",\n \"requestTimestamp\": {\n \"epochMillis\": \"1502220196077\"\n },\n \"paymentIntegratorAccountId\": \"InvisiCashUSA_USD\"\n },\n \"proxyKey\": {\n \"phoneNumber\": \"+001234567890\"\n }\n }\n\nAn example response looks like: \n\n\n {\n \"responseHeader\": {\n \"responseTimestamp\": {\n \"epochMillis\": \"1481900013178\"\n }\n },\n \"registrationStatus\": \"REGISTERED\"\n }\n\n### HTTP request\n\n`POST https://www.integratorhost.example.com/integrator-base-path/v2/getPayeeProxyRegistrationStatus`\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestHeader\": { object (/pay/banking-fop-v2/payment-integrator-banking-fop-api/RequestHeader) }, \"proxyKey\": { object (/pay/banking-fop-v2/payment-integrator-banking-fop-api/PayeeProxyKey) } } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestHeader` | `object (`[RequestHeader](/pay/banking-fop-v2/payment-integrator-banking-fop-api/RequestHeader)`)` **REQUIRED**: Common header for all requests. |\n| `proxyKey` | `object (`[PayeeProxyKey](/pay/banking-fop-v2/payment-integrator-banking-fop-api/PayeeProxyKey)`)` **REQUIRED**: The proxy key for which the registration status is being queried. |\n\n### Response body\n\nThis 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](/pay/banking-fop-v2/guides/connectivity/protocol-standards#http_status_codes).\n\n| Possible response messages ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| HTTP 200 Status | `object (`[GetPayeeProxyRegistrationStatusResponse](/pay/banking-fop-v2/payment-integrator-banking-fop-api/getPayeeProxyRegistrationStatus#GetPayeeProxyRegistrationStatusResponse)`)` |\n| HTTP 4XX / 5XX Status | `object (`[ErrorResponse](/pay/banking-fop-v2/payment-integrator-banking-fop-api/ErrorResponse)`)` |\n\nGetPayeeProxyRegistrationStatusResponse\n---------------------------------------\n\nResponse object for the banking-fop-v2.getPayeeProxyRegistrationStatus method\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responseHeader\": { object (/pay/banking-fop-v2/payment-integrator-banking-fop-api/ResponseHeader) }, \"registrationStatus\": enum (/pay/banking-fop-v2/payment-integrator-banking-fop-api/getPayeeProxyRegistrationStatus#PayeeProxyRegistrationStatus) } ``` |\n\n| Fields ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responseHeader` | `object (`[ResponseHeader](/pay/banking-fop-v2/payment-integrator-banking-fop-api/ResponseHeader)`)` **REQUIRED**: Common header for all responses. |\n| `registrationStatus` | `enum (`[PayeeProxyRegistrationStatus](/pay/banking-fop-v2/payment-integrator-banking-fop-api/getPayeeProxyRegistrationStatus#PayeeProxyRegistrationStatus)`)` **REQUIRED**: Registration status of the Proxy Key. |\n\nPayeeProxyRegistrationStatus\n----------------------------\n\nCodes that define the registration statuses.\n\n| Enums ||\n|-----------------------------------------------|-------------------------------------|\n| `PAYEE_PROXY_REGISTRATION_STATUS_UNSPECIFIED` | Do not ever set this default value! |\n| `REGISTERED` | The proxy key is registered. |\n| `NOT_REGISTERED` | The proxy key is not registered. |"]]