PayerInfo
Stay organized with collections
Save and categorize content based on your preferences.
Information about the person making the payment.
Fields |
payerTaxInfo |
object (TaxInfo )
OPTIONAL: Tax-related information about the payer, such as tax ID or orther relevant identifiers.
|
payerBankAccountIdentifier |
object (BankAccountIdentifier )
OPTIONAL: Banking details of the payer, potentially including bank name, account number, or other identifying information.
|
TaxInfo
Tax-related information about the payer.
JSON representation |
{
// Union field country can be only one of the following:
"brazil": {
object (BrazilTaxInfo )
}
// End of list of possible types for union field country .
} |
Fields |
Union field country . REQUIRED: Country-specific tax details for the payer. country can be only one of the following: |
brazil |
object (BrazilTaxInfo )
Specific tax details for Brazil.
|
BrazilTaxInfo
Tax-related information about the payer specific to Brazil.
JSON representation |
{
// Union field tax_number can be only one of the following:
"cnpj": string,
"cpf": string
// End of list of possible types for union field tax_number .
} |
Fields |
Union field tax_number . REQUIRED: The payer's Brazilian tax ID (CNPJ or CPF). tax_number can be only one of the following: |
cnpj |
string
Cadastro Nacional da Pessoa Jurídica (CNPJ), an identification number issued to Brazilian companies.
|
cpf |
string
Cadastro de Pessoas Físicas (CPF), the Brazilian individual taxpayer registry identification.
|
BankAccountIdentifier
Unique identifier of a bank account.
JSON representation |
{
// Union field account_identifier can be only one of the following:
"brazilBankAccount": {
object (BrazilBankAccountInfo )
}
// End of list of possible types for union field account_identifier .
} |
Fields |
Union field account_identifier . REQUIRED: Country-specific bank account details. account_identifier can be only one of the following: |
brazilBankAccount |
object (BrazilBankAccountInfo )
An account with a bank in Brazil.
|
BrazilBankAccountInfo
Details of a user's bank account in Brazil.
JSON representation |
{
"bankCode": string,
"branchCode": string,
"accountNumber": string
} |
Fields |
bankCode |
string
REQUIRED: The unique code identifying the bank associated with the payer's account.
|
branchCode |
string
REQUIRED: The specific code representing the branch where the payer's account is held.
|
accountNumber |
string
REQUIRED: The unique number identifying the payer's bank account.
|
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,["# PayerInfo\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [TaxInfo](#TaxInfo)\n - [JSON representation](#TaxInfo.SCHEMA_REPRESENTATION)\n- [BrazilTaxInfo](#BrazilTaxInfo)\n - [JSON representation](#BrazilTaxInfo.SCHEMA_REPRESENTATION)\n- [BankAccountIdentifier](#BankAccountIdentifier)\n - [JSON representation](#BankAccountIdentifier.SCHEMA_REPRESENTATION)\n- [BrazilBankAccountInfo](#BrazilBankAccountInfo)\n - [JSON representation](#BrazilBankAccountInfo.SCHEMA_REPRESENTATION)\n\nInformation about the person making the payment.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"payerTaxInfo\": { object (/pay/refundable-one-time-payment-code-v1/google-refundable-one-time-payment-code-api/PayerInfo#TaxInfo) }, \"payerBankAccountIdentifier\": { object (/pay/refundable-one-time-payment-code-v1/google-refundable-one-time-payment-code-api/PayerInfo#BankAccountIdentifier) } } ``` |\n\n| Fields ||\n|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `payerTaxInfo` | `object (`[TaxInfo](/pay/refundable-one-time-payment-code-v1/google-refundable-one-time-payment-code-api/PayerInfo#TaxInfo)`)` **OPTIONAL**: Tax-related information about the payer, such as tax ID or orther relevant identifiers. |\n| `payerBankAccountIdentifier` | `object (`[BankAccountIdentifier](/pay/refundable-one-time-payment-code-v1/google-refundable-one-time-payment-code-api/PayerInfo#BankAccountIdentifier)`)` **OPTIONAL**: Banking details of the payer, potentially including bank name, account number, or other identifying information. |\n\nTaxInfo\n-------\n\nTax-related information about the payer.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // Union field `country` can be only one of the following: \"brazil\": { object (/pay/refundable-one-time-payment-code-v1/google-refundable-one-time-payment-code-api/PayerInfo#BrazilTaxInfo) } // End of list of possible types for union field `country`. } ``` |\n\n| Fields ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Union field `country`. **REQUIRED** : Country-specific tax details for the payer. `country` can be only one of the following: ||\n| `brazil` | `object (`[BrazilTaxInfo](/pay/refundable-one-time-payment-code-v1/google-refundable-one-time-payment-code-api/PayerInfo#BrazilTaxInfo)`)` Specific tax details for Brazil. |\n\nBrazilTaxInfo\n-------------\n\nTax-related information about the payer specific to Brazil.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // Union field `tax_number` can be only one of the following: \"cnpj\": string, \"cpf\": string // End of list of possible types for union field `tax_number`. } ``` |\n\n| Fields ||\n|--------|---------------------------------------------------------------------------------------------------------------|\n| Union field `tax_number`. **REQUIRED** : The payer's Brazilian tax ID (CNPJ or CPF). `tax_number` can be only one of the following: ||\n| `cnpj` | `string` Cadastro Nacional da Pessoa Jurídica (CNPJ), an identification number issued to Brazilian companies. |\n| `cpf` | `string` Cadastro de Pessoas Físicas (CPF), the Brazilian individual taxpayer registry identification. |\n\nBankAccountIdentifier\n---------------------\n\nUnique identifier of a bank account.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // Union field `account_identifier` can be only one of the following: \"brazilBankAccount\": { object (/pay/refundable-one-time-payment-code-v1/google-refundable-one-time-payment-code-api/PayerInfo#BrazilBankAccountInfo) } // End of list of possible types for union field `account_identifier`. } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Union field `account_identifier`. **REQUIRED** : Country-specific bank account details. `account_identifier` can be only one of the following: ||\n| `brazilBankAccount` | `object (`[BrazilBankAccountInfo](/pay/refundable-one-time-payment-code-v1/google-refundable-one-time-payment-code-api/PayerInfo#BrazilBankAccountInfo)`)` An account with a bank in Brazil. |\n\nBrazilBankAccountInfo\n---------------------\n\nDetails of a user's bank account in Brazil.\n\n| JSON representation |\n|-------------------------------------------------------------------------------|\n| ``` { \"bankCode\": string, \"branchCode\": string, \"accountNumber\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------|\n| `bankCode` | `string` **REQUIRED**: The unique code identifying the bank associated with the payer's account. |\n| `branchCode` | `string` **REQUIRED**: The specific code representing the branch where the payer's account is held. |\n| `accountNumber` | `string` **REQUIRED**: The unique number identifying the payer's bank account. |"]]