# Models ## The WithdrawalSettings object ```json {"openapi":"3.1.0","info":{"title":"Partner Withdrawal Settings API","version":"14"},"components":{"schemas":{"WithdrawalSettings":{"type":"object","properties":{"PaymentMethod":{"type":"string","enum":["PAYPAL","BANK_TRANSFER"],"description":"How impact.com sends your payouts."},"PaypalEmailAddress":{"type":"string","description":"Email address of the PayPal account that receives payouts. Required when `PaymentMethod` is `PAYPAL`."},"BankCountry":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the country where the bank account is held."},"BeneficiaryAccountName":{"type":"string","description":"Full name on the bank account that will receive funds."},"BeneficiaryClassification":{"type":"string","enum":["BUSINESS","INDIVIDUAL","CPF","CNPJ"],"description":"Classification of the account holder. `BUSINESS` and `INDIVIDUAL` apply globally; `CPF` and `CNPJ` are Brazilian taxpayer types."},"ClassificationCode":{"type":"string","description":"Additional classification code required by some country/classification combinations (notably Brazil)."},"BeneficiaryAlternativeName":{"type":"string","description":"Alternative name on the account, where the bank's system requires one."},"BeneficiaryTaxPayerId":{"type":"string","description":"Taxpayer identifier of the beneficiary, in the format used by `BankCountry` (e.g., SSN/EIN for US, CPF/CNPJ for Brazil)."},"BankAccountType":{"type":"string","enum":["CHECKING","SAVINGS","NOT_SET"],"description":"Type of bank account that will receive funds."},"BankAccountNumber":{"type":"string","description":"The bank account number that will receive funds. For SEPA countries this is the IBAN."},"SwiftCode":{"type":"string","description":"SWIFT/BIC code identifying the receiving bank. Required for international transfers."},"RoutingCode":{"type":"string","description":"Domestic routing code for the receiving bank (e.g., US ABA routing number, UK sort code)."},"VoCode":{"type":"string","description":"Country-specific verification code used by some banking jurisdictions."},"AgencyCode":{"type":"string","description":"Bank agency identifier used in some Latin American banking systems."},"BankAddress":{"type":"string","description":"Street address of the receiving bank branch."},"BankPostalCode":{"type":"string","description":"Postal code of the receiving bank branch."},"BankCity":{"type":"string","description":"City of the receiving bank branch."},"BankState":{"type":"string","description":"State or province of the receiving bank branch."},"BranchCode":{"type":"string","description":"Branch identifier code (e.g., transit number, sort code segment, branch number)."},"BankName":{"type":"string","description":"Name of the receiving bank."},"BranchName":{"type":"string","description":"Name of the receiving bank's branch."},"PaymentSchedulingType":{"type":"string","enum":["BALANCE_THRESHOLD","FIXED_DAY"],"description":"Determines whether payouts trigger by balance threshold or on a fixed day of the month."},"PaymentThreshold":{"type":"string","description":"Minimum account balance that triggers a payout when `PaymentSchedulingType` is `BALANCE_THRESHOLD`. Min $20 USD, max $10,000 USD."},"PaymentDay":{"type":"string","description":"Day of the month payouts are issued when `PaymentSchedulingType` is `FIXED_DAY`. Either `1` or `15`. Returns `0` when not applicable."},"Uri":{"type":"string","description":"API resource path for these withdrawal settings."}}}}}} ``` ## The WithdrawalSettingsUpdate object ```json {"openapi":"3.1.0","info":{"title":"Partner Withdrawal Settings API","version":"14"},"components":{"schemas":{"WithdrawalSettingsUpdate":{"type":"object","description":"Fields you can submit to update withdrawal settings. Any field omitted from the request is left unchanged.","properties":{"PaymentMethod":{"type":"string","enum":["PAYPAL","BANK_TRANSFER"],"description":"How impact.com sends your payouts. Required when changing payout method."},"PaypalEmailAddress":{"type":"string","description":"Email address of the PayPal account that receives payouts. Required when `PaymentMethod` is `PAYPAL`."},"BeneficiaryAccountName":{"type":"string","description":"Full name on the bank account that will receive funds."},"BankCountry":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the bank account is held."},"BeneficiaryClassification":{"type":"string","enum":["BUSINESS","INDIVIDUAL","CPF","CNPJ"],"description":"Classification of the account holder. `BUSINESS` and `INDIVIDUAL` apply globally; `CPF` and `CNPJ` are Brazilian taxpayer types."},"ClassificationCode":{"type":"string","description":"Additional classification code required by some country/classification combinations (notably Brazil)."},"BeneficiaryAlternativeName":{"type":"string","description":"Alternative name on the account, where the bank's system requires one."},"BeneficiaryTaxPayerId":{"type":"string","description":"Taxpayer identifier of the beneficiary, in the format used by `BankCountry` (e.g., SSN/EIN for US, CPF/CNPJ for Brazil)."},"BankAccountType":{"type":"string","enum":["CHECKING","SAVINGS","NOT_SET"],"description":"Type of bank account that will receive funds."},"BankAccountNumber":{"type":"string","description":"The bank account number that will receive funds. For SEPA countries this is the IBAN."},"SwiftCode":{"type":"string","description":"SWIFT/BIC code identifying the receiving bank. Required for international transfers."},"RoutingCode":{"type":"string","description":"Domestic routing code for the receiving bank (e.g., US ABA routing number, UK sort code)."},"VoCode":{"type":"string","description":"Country-specific verification code used by some banking jurisdictions."},"AgencyCode":{"type":"string","description":"Bank agency identifier used in some Latin American banking systems."},"BankAddress":{"type":"string","description":"Street address of the receiving bank branch."},"BankPostalCode":{"type":"string","description":"Postal code of the receiving bank branch."},"BankCity":{"type":"string","description":"City of the receiving bank branch."},"BankState":{"type":"string","description":"State or province of the receiving bank branch."},"BranchCode":{"type":"string","description":"Branch identifier code (e.g., transit number, sort code segment, branch number)."},"BankName":{"type":"string","description":"Name of the receiving bank."},"BranchName":{"type":"string","description":"Name of the receiving bank's branch."},"PaymentSchedulingType":{"type":"string","enum":["BALANCE_THRESHOLD","FIXED_DAY"],"description":"Determines whether payouts trigger by balance threshold or on a fixed day of the month."},"PaymentThreshold":{"type":"string","description":"Minimum balance that triggers a payout when `PaymentSchedulingType` is `BALANCE_THRESHOLD`. Min $20 USD, max $10,000 USD."},"PaymentDay":{"type":"string","description":"Day of month payouts are issued when `PaymentSchedulingType` is `FIXED_DAY`. Either `1` or `15`."}}}}}} ``` ## The RequiredFieldsResponse object ```json {"openapi":"3.1.0","info":{"title":"Partner Withdrawal Settings API","version":"14"},"components":{"schemas":{"RequiredFieldsResponse":{"type":"object","properties":{"BankCountry":{"type":"string","description":"Country the requirements apply to."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code paid out for accounts in this country."},"PaymentMethods":{"type":"object","description":"Required-field listing keyed by payment method (e.g., `PAYPAL`, `BANK_TRANSFER`).","additionalProperties":{"type":"object","properties":{"RequiredFields":{"type":"array","description":"Names of `WithdrawalSettings` fields that must be supplied for this payment method.","items":{"type":"string"}}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://integrations.impact.com/partner-api-reference/partner-v14/reference/withdrawal-settings/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.