Possible Pointers
DOCS
Last updated: Aug 15th, 7:59am
This table lists the possible paths where you can replace, add, or delete information by using the PATCH operation. Pointers are in alphabetical order by the first part of their path name.
| Path | Replace | Add | Delete |
|---|---|---|---|
/account_permissions | No | Yes | Yes |
/business_info/addresses/@type==mailing_address/city | Yes | Yes | No |
/business_info/addresses/@type==mailing_address/country_code | No | Yes | No |
/business_info/addresses/@type==mailing_address/line1 | Yes | Yes | No |
/business_info/addresses/@type==mailing_address/line2 | Yes | Yes | Yes |
/business_info/addresses/@type==mailing_address/postal_code | Yes | Yes | No |
/business_info/addresses/@type==mailing_address/state | Yes | Yes | No |
/business_info/addresses/@type==registered_office/city | Yes | Yes | No |
/business_info/addresses/@type==registered_office/country_code | No | Yes | No |
/business_info/addresses/@type==registered_office/line1 | Yes | Yes | No |
/business_info/addresses/@type==registered_office/line2 | Yes | Yes | Yes |
/business_info/addresses/@type==registered_office/postal_code | Yes | Yes | No |
/business_info/addresses/@type==registered_office/state | Yes | Yes | No |
/business_info/addresses/@type==work/city | Yes | Yes | No |
/business_info/addresses/@type==work/country_code | No | Yes | No |
/business_info/addresses/@type==work/line1 | Yes | Yes | No |
/business_info/addresses/@type==work/line2 | Yes | Yes | Yes |
/business_info/addresses/@type==work/postal_code | Yes | Yes | No |
/business_info/addresses/@type==work/state | Yes | Yes | No |
/business_info/business_category/merchant_category_code | Yes | Yes | No |
/business_info/business_sales_details/average_monthly_volume | Yes | Yes | No |
/business_info/business_sales_details/average_monthly_volume/maximum_amount/currency_code | Yes | Yes | No |
/business_info/business_sales_details/average_monthly_volume/maximum_amount/value | Yes | Yes | No |
/business_info/business_sales_details/average_monthly_volume/minimum_amount/currency_code | Yes | Yes | No |
/business_info/business_sales_details/average_monthly_volume/minimum_amount/value | Yes | Yes | No |
/business_info/business_sales_details/average_price/maximum_amount/currency_code | No | Yes | No |
/business_info/business_sales_details/average_price/minimum_amount/currency_code | No | Yes | No |
/business_info/business_sales_details/sales_venues | No | Yes | No |
/business_info/business_sales_details/sales_venues/@type==ebay/ebay_id | Yes | Yes | Yes |
/business_info/business_sales_details/sales_venues/@type==other/description | Yes | Yes | Yes |
/business_info/business_sales_details/website | Yes | Yes | Yes |
/business_info/business_sales_details/revenue_from_online_sales | Yes | Yes | No |
/business_info/category | Yes | Yes | No |
/business_info/country_code_of_incorporation | Yes | Yes | Yes |
/business_info/customer_service/phone/country_code | Yes | Yes | No |
/business_info/customer_service/email | Yes | No | No |
/business_info/customer_service/phone | No | Yes | No |
/business_info/customer_service/phone/extension_number | Yes | Yes | Yes |
/business_info/customer_service/phone/national_number | Yes | Yes | No |
/business_info/date_business_established | Yes | Yes | No |
/business_info/date_of_registration | Yes | Yes | No |
/business_info/designation/business_area | Yes | Yes | Yes |
/business_info/designation/title | Yes | Yes | Yes |
/business_info/dispute_email | Yes | Yes | No |
/business_info/email_address | Yes | Yes | No |
/business_info/employer_identification_number | Yes | Yes | Yes |
/business_info/government_body | Yes | Yes | Yes |
/business_info/identifications | No | Yes | No |
/business_info/identifications/@type==association_number | Yes | No | Yes |
/business_info/identifications/@type==business_number | Yes | No | Yes |
/business_info/identifications/@type==business_registration_number | Yes | No | Yes |
/business_info/identifications/@type==company_number | Yes | No | Yes |
/business_info/identifications/@type==cooperative_number | Yes | No | Yes |
/business_info/identifications/@type==employer_identification_number | Yes | No | Yes |
/business_info/identifications/@type==value_added_tax_id | Yes | No | Yes |
/business_info/merchant_category_code | Yes | Yes | No |
/business_info/names | No | Yes | No |
/business_info/names/@type==doing_business_as | No | No | Yes |
/business_info/names/@type==doing_business_as/name | Yes | Yes | No |
/business_info/names/@type==legal/name | Yes | Yes | No |
/business_info/place_of_establishment | No | Yes | No |
/business_info/place_of_establishment/country_code | Yes | Yes | No |
/business_info/place_of_establishment/state | Yes | Yes | No |
/business_info/phones | No | Yes | No |
/business_info/phones/@type==business/country_code | Yes | No | No |
/business_info/phones/@type==business/national_number | Yes | No | No |
/business_info/phones/@type==work/country_code | Yes | No | No |
/business_info/phones/@type==work/extension_number | Yes | Yes | No |
/business_info/phones/@type==work/national_number | Yes | No | No |
/business_info/stakeholders | Yes | Yes | Yes |
/business_info/sub_category | Yes | Yes | No |
/business_info/sub_type | Yes | Yes | Yes |
/business_info/type | Yes | Yes | No |
/financial_info/bank_accounts | Yes | Yes | Yes |
/financial_instruments/banks | Yes | Yes | Yes |
/financial_instruments/banks@id==`ba-[a-z1-9]+` | Yes | No | Yes |
/inheritance/1 | No | Yes | No |
/inheritance/2 | No | Yes | No |
/inheritance/3 | No | Yes | No |
/inheritance/4 | No | Yes | No |
/inheritance/5 | No | Yes | No |
/inheritance/6 | No | Yes | No |
/inheritance/7 | No | Yes | No |
/inheritance/8 | No | Yes | No |
/owner_info/addresses | No | Yes | No |
/owner_info/addresses/@type==home/city | Yes | Yes | No |
/owner_info/addresses/@type==home/country_code | No | Yes | No |
/owner_info/addresses/@type==home/postal_code | Yes | Yes | No |
/owner_info/addresses/@type==home/line1 | Yes | Yes | No |
/owner_info/addresses/@type==home/line2 | Yes | Yes | Yes |
/owner_info/addresses/@type==home/state | Yes | Yes | No |
/owner_info/country_code_of_nationality | Yes | Yes | No |
/owner_info/date_of_birth | Yes | Yes | No |
/owner_info/identifications | No | Yes | No |
/owner_info/identifications/@type==drivers_license | Yes | No | Yes |
/owner_info/identifications/@type==immigrant_id | Yes | No | Yes |
/owner_info/identifications/@type==passport_number | Yes | No | Yes |
/owner_info/identifications/@type==pension_fund_id | Yes | No | Yes |
/owner_info/identifications/@type==medical_insurance_id | Yes | No | Yes |
/owner_info/identifications/@type==national_id | Yes | No | Yes |
/owner_info/identifications/@type==social_insurance_number | Yes | No | Yes |
/owner_info/identifications/@type==social_security_number | Yes | No | Yes |
/owner_info/identifications/@type==individual_tax_identification_number | Yes | No | Yes |
/owner_info/name/given_name | Yes | Yes | No |
/owner_info/name/middle_name | Yes | Yes | Yes |
/owner_info/name/prefix | Yes | Yes | Yes |
/owner_info/occupation | Yes | Yes | Yes |
/owner_info/phones | No | Yes | No |
/owner_info/phones/@type==home | No | No | Yes |
/owner_info/phones/@type==home/country_code | Yes | Yes | No |
/owner_info/phones/@type==home/national_number | Yes | Yes | No |
/owner_info/phones/@type==mobile | No | No | Yes |
/owner_info/phones/@type==mobile/country_code | Yes | Yes | No |
/owner_info/phones/@type==mobile/national_number | Yes | Yes | No |
/owner_info/ssn | Yes | Yes | Yes |
/owner_info/name/suffix | Yes | Yes | Yes |
/owner_info/name/surname | Yes | Yes | No |
/partner_merchant_external_id | Yes | Yes | No |
/partner_tax_reporting | Yes | Yes | No |
/payment_receiving_preferences/block_echeck_payments | Yes | Yes | No |
/payment_receiving_preferences/block_non_us_payments | Yes | Yes | No |
/payment_receiving_preferences/alternate_payment_url | Yes | Yes | No |
/payment_receiving_preferences/block_cross_currency_payments | Yes | Yes | No |
/payment_receiving_preferences/block_send_money_payments | Yes | Yes | No |
/payment_receiving_preferences/block_unconfirmed_us_address_payments | Yes | Yes | No |
/payment_receiving_preferences/cc_soft_descriptor | Yes | Yes | No |
/payment_receiving_preferences/cc_soft_descriptor_extended | Yes | Yes | No |
/payment_receiving_preferences/display_instructions_text_input | Yes | Yes | No |
/secondary_currency | No | Yes | No |
/timezone | Yes | Yes | No |