PayeeProxyKey

  • PayeeProxyKey acts as a Payee identifier and enables querying registration status and display information within the PayeeProxy directory.

  • It 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.

  • ProxyKeyNationalId, a specific proxy key type, comprises the national ID number and its issuing country's ISO-3166-1 Alpha-2 code.

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.