PayeeProxyKey
Stay organized with collections
Save and categorize content based on your preferences.
ProxyKey that may be used as a Payee if the proxy key is registered with a PayeeProxy directory and may be used to query the registration status or to retrieve display information from the directory.
| JSON representation |
{
"networkId": string,
// Union field proxy_key can be only one of the following:
"phoneNumber": string,
"nationalId": {
object (ProxyKeyNationalId)
},
"businessId": string,
"virtualPaymentAddress": string,
"qrCode": string
// End of list of possible types for union field proxy_key.
} |
| Fields |
networkId |
string
REQUIRED: Network Id for the payee proxy. For example, 'PaymentNetwork1', 'PaymentNetwork2', etc.
|
Union field proxy_key. REQUIRED: The Payee proxy key. proxy_key can be only one of the following: |
phoneNumber |
string
A proxy key that is a phone number.
|
nationalId |
object (ProxyKeyNationalId)
A proxy key that is a national ID number.
|
businessId |
string
A proxy key that is a business ID number.
|
virtualPaymentAddress |
string
A proxy key that is a virtual payment address.
|
qrCode |
string
A proxy key that is a QR code. For example, an EMVCo QR.
|
ProxyKeyNationalId
A proxy key that is a national ID number.
| JSON representation |
{
"nationalId": string,
"issuingCountryCode": string
} |
| Fields |
nationalId |
string
REQUIRED: The value of the national ID number.
|
issuingCountryCode |
string
REQUIRED: ID issuing country's country code, expected to be ISO-3166-1 Alpha-2.
|
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-29 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-07-29 UTC."],[[["\u003cp\u003ePayeeProxyKey acts as a Payee identifier and enables querying registration status and display information within the PayeeProxy directory.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes a network ID and a single proxy key, which can be a phone number, national ID, business ID, virtual payment address, or QR code.\u003c/p\u003e\n"],["\u003cp\u003eProxyKeyNationalId, a specific proxy key type, comprises the national ID number and its issuing country's ISO-3166-1 Alpha-2 code.\u003c/p\u003e\n"]]],["The core content describes `ProxyKey`, a type of identifier used for payees. It includes a `networkId` and one of the following proxy keys: `phoneNumber`, `nationalId`, `businessId`, `virtualPaymentAddress`, or `qrCode`. The `nationalId` proxy key type (`ProxyKeyNationalId`) requires the national ID number and the issuing country's two-letter code (ISO-3166-1 Alpha-2). This key is for querying registration status and retrieving display information from a `PayeeProxy` directory.\n"],null,["- [JSON representation](#SCHEMA_REPRESENTATION)\n- [ProxyKeyNationalId](#ProxyKeyNationalId)\n - [JSON representation](#ProxyKeyNationalId.SCHEMA_REPRESENTATION)\n\nProxyKey that may be used as a Payee if the proxy key is registered with a PayeeProxy directory and may be used to query the registration status or to retrieve display information from the directory.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"networkId\": string, // Union field `proxy_key` can be only one of the following: \"phoneNumber\": string, \"nationalId\": { object (/pay/banking-fop-v2/payment-integrator-banking-fop-api/PayeeProxyKey#ProxyKeyNationalId) }, \"businessId\": string, \"virtualPaymentAddress\": string, \"qrCode\": string // End of list of possible types for union field `proxy_key`. } ``` |\n\n| Fields ||\n|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `networkId` | `string` **REQUIRED**: Network Id for the payee proxy. For example, 'PaymentNetwork1', 'PaymentNetwork2', etc. |\n| Union field `proxy_key`. `proxy_key` can be only one of the following: ||\n| `phoneNumber` | `string` A proxy key that is a phone number. |\n| `nationalId` | `object (`[ProxyKeyNationalId](/pay/banking-fop-v2/payment-integrator-banking-fop-api/PayeeProxyKey#ProxyKeyNationalId)`)` A proxy key that is a national ID number. |\n| `businessId` | `string` A proxy key that is a business ID number. |\n| `virtualPaymentAddress` | `string` A proxy key that is a virtual payment address. |\n| `qrCode` | `string` A proxy key that is a QR code. For example, an EMVCo QR. |\n\nProxyKeyNationalId A proxy key that is a national ID number.\n\n| JSON representation |\n|----------------------------------------------------------------|\n| ``` { \"nationalId\": string, \"issuingCountryCode\": string } ``` |\n\n| Fields ||\n|----------------------|----------------------------------------------------------------------------------------------|\n| `nationalId` | `string` **REQUIRED**: The value of the national ID number. |\n| `issuingCountryCode` | `string` **REQUIRED**: ID issuing country's country code, expected to be ISO-3166-1 Alpha-2. |"]]