PayeeProxyDestination
Stay organized with collections
Save and categorize content based on your preferences.
Destination for Payee that uses a PayeeProxy key to reference a payee.
JSON representation |
{
"payeeProxyKey": {
object (PayeeProxyKey )
},
"payeeProxyLookupRequestId": string
} |
Fields |
payeeProxyKey |
object (PayeeProxyKey )
REQUIRED: Proxy Key that will be used for the Payee.
|
payeeProxyLookupRequestId |
string
OPTIONAL: requestId from a lookup for this PayeeProxyKey (if applicable). This value will be set when there was a DisplayInfo lookup done for this PayeeProxyKey in the context of this transfer.
|
PayeeProxyKey
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: Oneof proxy key for 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."],[],[],null,["# PayeeProxyDestination\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [PayeeProxyKey](#PayeeProxyKey)\n - [JSON representation](#PayeeProxyKey.SCHEMA_REPRESENTATION)\n- [ProxyKeyNationalId](#ProxyKeyNationalId)\n - [JSON representation](#ProxyKeyNationalId.SCHEMA_REPRESENTATION)\n\nDestination for Payee that uses a PayeeProxy key to reference a payee.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"payeeProxyKey\": { object (/pay/e-wallets-v1/payment-integrator-e-wallets-api/PayeeProxyDestination#PayeeProxyKey) }, \"payeeProxyLookupRequestId\": string } ``` |\n\n| Fields ||\n|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `payeeProxyKey` | `object (`[PayeeProxyKey](/pay/e-wallets-v1/payment-integrator-e-wallets-api/PayeeProxyDestination#PayeeProxyKey)`)` **REQUIRED**: Proxy Key that will be used for the Payee. |\n| `payeeProxyLookupRequestId` | `string` **OPTIONAL** : `requestId` from a lookup for this PayeeProxyKey (if applicable). This value will be set when there was a DisplayInfo lookup done for this PayeeProxyKey in the context of this transfer. |\n\nPayeeProxyKey\n-------------\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/e-wallets-v1/payment-integrator-e-wallets-api/PayeeProxyDestination#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`. **REQUIRED** : Oneof proxy key for payee 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/e-wallets-v1/payment-integrator-e-wallets-api/PayeeProxyDestination#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\n------------------\n\nA 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. |"]]