Pular para o conteúdo principal

Referência do conector PayPal

info

Beta

Este recurso está em Beta. Para usá-lo, um administrador do workspace deve ativar o Lakeflow Connect para PayPal na página Prévias . Consulte Gerenciar prévias do Databricks.

Esta página contém informações de referência para o conector gerenciado do PayPal, incluindo tabelas de origem compatíveis e esquemas de tabela de destino.

Tabelas de origem compatíveis​

O conector PayPal oferece suporte às seguintes tabelas de origem, todas sob o esquema de origem default:

Tabela de origem

Chave primária

Descrição

Modo de sincronização

Campo do cursor

transaction

transaction_id, transaction_event_code

Transações da account da API de pesquisa de transações do PayPal, uma linha por evento de transação.

Incremental

transaction_initiation_date

dispute

dispute_id

Disputas de clientes, reclamações e estornos com detalhes completos da disputa.

Incremental

update_time

invoice

id

Faturas com seus detalhes, destinatários, itens, pagamentos e reembolsos.

Incremental

last_update_time

balance

account_id, currency

Saldos atuais da account, uma linha por moeda.

Somente refresh completo

product

id

Produtos do catálogo.

Somente refresh completo

billing_plan

id

Planos de cobrança de inscrição.

Somente refresh completo

Tabela de origem

Chave primária

Descrição

Modo de sincronização

Campo do cursor

transaction

transaction_id, transaction_event_code

Transações da account da API de pesquisa de transações do PayPal, uma linha por evento de transação.

Incremental

transaction_initiation_date

dispute

dispute_id

Disputas de clientes, reclamações e estornos com detalhes completos da disputa.

Incremental

update_time

invoice

id

Faturas com seus detalhes, destinatários, itens, pagamentos e reembolsos.

Incremental

last_update_time

balance

account_id, currency

Saldos atuais da account, uma linha por moeda.

Somente refresh completo

product

id

Produtos do catálogo.

Somente refresh completo

billing_plan

id

Planos de cobrança de inscrição.

Somente refresh completo

Opções de conector​

Para uso, veja Exemplos.

Opção

Tipo

Escopo

Obrigatório

Aplica-se a

Descrição

start_datetime

String

Pipeline

Não

transaction, dispute, invoice

Data e hora mais antigas a partir das quais ingerir dados, no formato yyyy-MM-ddTHH:mm:ssZ (por exemplo, 2024-01-01T00:00:00Z). Aplica-se apenas à primeira sincronização de cada tabela; as sincronizações posteriores continuam a partir do cursor armazenado. Se você não definir, o transaction começa cerca de 3 anos atrás, o dispute começa 179 dias atrás e o invoice começa 5 anos atrás. Os valores anteriores à janela de retenção do PayPal são movidos para 3 anos para transaction e 179 dias para dispute.

Opção

Tipo

Escopo

Obrigatório

Aplica-se a

Descrição

start_datetime

String

Pipeline

Não

transaction, dispute, invoice

Data e hora mais antigas a partir das quais ingerir dados, no formato yyyy-MM-ddTHH:mm:ssZ (por exemplo, 2024-01-01T00:00:00Z). Aplica-se apenas à primeira sincronização de cada tabela; as sincronizações posteriores continuam a partir do cursor armazenado. Se você não definir, o transaction começa cerca de 3 anos atrás, o dispute começa 179 dias atrás e o invoice começa 5 anos atrás. Os valores anteriores à janela de retenção do PayPal são movidos para 3 anos para transaction e 179 dias para dispute.

Esquemas de tabela de destino​

transaction​

key primária: transaction_id, transaction_event_code Campo do cursor: transaction_initiation_date

campo

Tipo de dados

transaction_id

STRING

transaction_event_code

STRING

transaction_initiation_date

TIMESTAMP

transaction_updated_date

TIMESTAMP

transaction_info

STRUCT<paypal_account_id: STRING, transaction_id: STRING, paypal_reference_id: STRING, paypal_reference_id_type: STRING, transaction_event_code: STRING, transaction_initiation_date: TIMESTAMP, transaction_updated_date: TIMESTAMP, transaction_amount: STRUCT<currency_code: STRING, value: STRING>, fee_amount: STRUCT<currency_code: STRING, value: STRING>, discount_amount: STRUCT<currency_code: STRING, value: STRING>, insurance_amount: STRUCT<currency_code: STRING, value: STRING>, sales_tax_amount: STRUCT<currency_code: STRING, value: STRING>, shipping_amount: STRUCT<currency_code: STRING, value: STRING>, shipping_discount_amount: STRUCT<currency_code: STRING, value: STRING>, shipping_tax_amount: STRUCT<currency_code: STRING, value: STRING>, other_amount: STRUCT<currency_code: STRING, value: STRING>, tip_amount: STRUCT<currency_code: STRING, value: STRING>, transaction_status: STRING, transaction_subject: STRING, transaction_note: STRING, payment_tracking_id: STRING, bank_reference_id: STRING, ending_balance: STRUCT<currency_code: STRING, value: STRING>, available_balance: STRUCT<currency_code: STRING, value: STRING>, invoice_id: STRING, custom_field: STRING, protection_eligibility: STRING, credit_term: STRING, credit_transactional_fee: STRUCT<currency_code: STRING, value: STRING>, credit_promotional_fee: STRUCT<currency_code: STRING, value: STRING>, annual_percentage_rate: STRING, payment_method_type: STRING, instrument_type: STRING, instrument_sub_type: STRING>

payer_info

STRUCT<account_id: STRING, email_address: STRING, phone_number: STRUCT<country_code: STRING, national_number: STRING, extension_number: STRING>, address_status: STRING, payer_status: STRING, payer_name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, country_code: STRING, address: STRUCT<line1: STRING, line2: STRING, city: STRING, state: STRING, country_code: STRING, postal_code: STRING>>

shipping_info

STRUCT<name: STRING, method: STRING, address: STRUCT<line1: STRING, line2: STRING, city: STRING, state: STRING, country_code: STRING, postal_code: STRING>, secondary_shipping_address: STRUCT<line1: STRING, line2: STRING, city: STRING, state: STRING, country_code: STRING, postal_code: STRING>>

cart_info

STRUCT<item_details: ARRAY<STRUCT<item_code: STRING, item_name: STRING, item_description: STRING, item_options: STRING, item_quantity: STRING, item_unit_price: STRUCT<currency_code: STRING, value: STRING>, item_amount: STRUCT<currency_code: STRING, value: STRING>, discount_amount: STRUCT<currency_code: STRING, value: STRING>, adjustment_amount: STRUCT<currency_code: STRING, value: STRING>, gift_wrap_amount: STRUCT<currency_code: STRING, value: STRING>, tax_percentage: STRING, tax_amounts: ARRAY<STRUCT<tax_amount: STRUCT<currency_code: STRING, value: STRING>>>, basic_shipping_amount: STRUCT<currency_code: STRING, value: STRING>, extra_shipping_amount: STRUCT<currency_code: STRING, value: STRING>, handling_amount: STRUCT<currency_code: STRING, value: STRING>, insurance_amount: STRUCT<currency_code: STRING, value: STRING>, total_item_amount: STRUCT<currency_code: STRING, value: STRING>, invoice_number: STRING, checkout_options: ARRAY<STRUCT<checkout_option_name: STRING, checkout_option_value: STRING>>>>, tax_inclusive: BOOLEAN, paypal_invoice_id: STRING>

store_info

STRUCT<store_id: STRING, terminal_id: STRING>

auction_info

STRUCT<auction_site: STRING, auction_item_site: STRING, auction_buyer_id: STRING, auction_closing_date: TIMESTAMP>

incentive_info

STRUCT<incentive_details: ARRAY<STRUCT<incentive_type: STRING, incentive_code: STRING, incentive_amount: STRUCT<currency_code: STRING, value: STRING>, incentive_program_code: STRING>>>

last_refreshed_datetime

TIMESTAMP

account_number

STRING

campo

Tipo de dados

transaction_id

STRING

transaction_event_code

STRING

transaction_initiation_date

TIMESTAMP

transaction_updated_date

TIMESTAMP

transaction_info

STRUCT<paypal_account_id: STRING, transaction_id: STRING, paypal_reference_id: STRING, paypal_reference_id_type: STRING, transaction_event_code: STRING, transaction_initiation_date: TIMESTAMP, transaction_updated_date: TIMESTAMP, transaction_amount: STRUCT<currency_code: STRING, value: STRING>, fee_amount: STRUCT<currency_code: STRING, value: STRING>, discount_amount: STRUCT<currency_code: STRING, value: STRING>, insurance_amount: STRUCT<currency_code: STRING, value: STRING>, sales_tax_amount: STRUCT<currency_code: STRING, value: STRING>, shipping_amount: STRUCT<currency_code: STRING, value: STRING>, shipping_discount_amount: STRUCT<currency_code: STRING, value: STRING>, shipping_tax_amount: STRUCT<currency_code: STRING, value: STRING>, other_amount: STRUCT<currency_code: STRING, value: STRING>, tip_amount: STRUCT<currency_code: STRING, value: STRING>, transaction_status: STRING, transaction_subject: STRING, transaction_note: STRING, payment_tracking_id: STRING, bank_reference_id: STRING, ending_balance: STRUCT<currency_code: STRING, value: STRING>, available_balance: STRUCT<currency_code: STRING, value: STRING>, invoice_id: STRING, custom_field: STRING, protection_eligibility: STRING, credit_term: STRING, credit_transactional_fee: STRUCT<currency_code: STRING, value: STRING>, credit_promotional_fee: STRUCT<currency_code: STRING, value: STRING>, annual_percentage_rate: STRING, payment_method_type: STRING, instrument_type: STRING, instrument_sub_type: STRING>

payer_info

STRUCT<account_id: STRING, email_address: STRING, phone_number: STRUCT<country_code: STRING, national_number: STRING, extension_number: STRING>, address_status: STRING, payer_status: STRING, payer_name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, country_code: STRING, address: STRUCT<line1: STRING, line2: STRING, city: STRING, state: STRING, country_code: STRING, postal_code: STRING>>

shipping_info

STRUCT<name: STRING, method: STRING, address: STRUCT<line1: STRING, line2: STRING, city: STRING, state: STRING, country_code: STRING, postal_code: STRING>, secondary_shipping_address: STRUCT<line1: STRING, line2: STRING, city: STRING, state: STRING, country_code: STRING, postal_code: STRING>>

cart_info

STRUCT<item_details: ARRAY<STRUCT<item_code: STRING, item_name: STRING, item_description: STRING, item_options: STRING, item_quantity: STRING, item_unit_price: STRUCT<currency_code: STRING, value: STRING>, item_amount: STRUCT<currency_code: STRING, value: STRING>, discount_amount: STRUCT<currency_code: STRING, value: STRING>, adjustment_amount: STRUCT<currency_code: STRING, value: STRING>, gift_wrap_amount: STRUCT<currency_code: STRING, value: STRING>, tax_percentage: STRING, tax_amounts: ARRAY<STRUCT<tax_amount: STRUCT<currency_code: STRING, value: STRING>>>, basic_shipping_amount: STRUCT<currency_code: STRING, value: STRING>, extra_shipping_amount: STRUCT<currency_code: STRING, value: STRING>, handling_amount: STRUCT<currency_code: STRING, value: STRING>, insurance_amount: STRUCT<currency_code: STRING, value: STRING>, total_item_amount: STRUCT<currency_code: STRING, value: STRING>, invoice_number: STRING, checkout_options: ARRAY<STRUCT<checkout_option_name: STRING, checkout_option_value: STRING>>>>, tax_inclusive: BOOLEAN, paypal_invoice_id: STRING>

store_info

STRUCT<store_id: STRING, terminal_id: STRING>

auction_info

STRUCT<auction_site: STRING, auction_item_site: STRING, auction_buyer_id: STRING, auction_closing_date: TIMESTAMP>

incentive_info

STRUCT<incentive_details: ARRAY<STRUCT<incentive_type: STRING, incentive_code: STRING, incentive_amount: STRUCT<currency_code: STRING, value: STRING>, incentive_program_code: STRING>>>

last_refreshed_datetime

TIMESTAMP

account_number

STRING

dispute​

key primária: dispute_id Campo do cursor: update_time

campo

Tipo de dados

dispute_id

STRING

create_time

TIMESTAMP

update_time

TIMESTAMP

disputed_transactions

ARRAY<STRUCT<buyer_transaction_id: STRING, seller_transaction_id: STRING, reference_id: STRING, create_time: TIMESTAMP, transaction_status: STRING, gross_amount: STRUCT<currency_code: STRING, value: STRING>, gross_asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, invoice_number: STRING, custom: STRING, buyer: STRUCT<name: STRING, email: STRING, payer_id: STRING>, seller: STRUCT<email: STRING, merchant_id: STRING, name: STRING>, items: ARRAY<STRUCT<item_id: STRING, item_name: STRING, item_description: STRING, item_quantity: STRING, partner_transaction_id: STRING, reason: STRING, dispute_amount: STRUCT<currency_code: STRING, value: STRING>, notes: STRING, item_type: STRING, product_details: VARIANT, service_details: VARIANT, booking_details: VARIANT, digital_download_details: VARIANT, cancellation_details: VARIANT, agreed_refund_details: VARIANT>>, payment_processor: VARIANT, seller_protection_eligible: BOOLEAN, seller_protection_type: STRING>>

reason

STRING

status

STRING

dispute_state

STRING

dispute_amount

STRUCT<currency_code: STRING, value: STRING>

dispute_asset

STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>

fee_policy

VARIANT

external_reason_code

STRING

dispute_outcome

STRUCT<outcome_code: STRING, outcome_reason: STRING, amount_refunded: STRUCT<currency_code: STRING, value: STRING>, asset_refunded: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>>

adjudications

ARRAY<STRUCT<type: STRING, adjudication_time: TIMESTAMP, reason: STRING, dispute_life_cycle_stage: STRING>>

money_movements

ARRAY<STRUCT<affected_party: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, initiated_time: TIMESTAMP, type: STRING, reason: STRING>>

fund_movements

ARRAY<STRUCT<party: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, initiated_time: TIMESTAMP, type: STRING, reason: STRING>>

dispute_life_cycle_stage

STRING

dispute_channel

STRING

messages

ARRAY<STRUCT<posted_by: STRING, time_posted: TIMESTAMP, content: STRING, documents: ARRAY<STRUCT<name: STRING, url: STRING>>>>

extensions

STRUCT<merchant_contacted: BOOLEAN, merchant_contacted_outcome: STRING, merchant_contacted_time: TIMESTAMP, merchant_contacted_mode: STRING, buyer_contacted_time: TIMESTAMP, buyer_contacted_channel: STRING, billing_dispute_properties: STRUCT<duplicate_transaction: STRUCT<received_duplicate: BOOLEAN, original_transaction: STRUCT<buyer_transaction_id: STRING, seller_transaction_id: STRING, reference_id: STRING, create_time: TIMESTAMP, transaction_status: STRING, gross_amount: STRUCT<currency_code: STRING, value: STRING>, gross_asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, invoice_number: STRING, custom: STRING, buyer: STRUCT<name: STRING, email: STRING, payer_id: STRING>, seller: STRUCT<email: STRING, merchant_id: STRING, name: STRING>, items: ARRAY<STRUCT<item_id: STRING, item_name: STRING, item_description: STRING, item_quantity: STRING, partner_transaction_id: STRING, reason: STRING, dispute_amount: STRUCT<currency_code: STRING, value: STRING>, notes: STRING, item_type: STRING, product_details: VARIANT, service_details: VARIANT, booking_details: VARIANT, digital_download_details: VARIANT, cancellation_details: VARIANT, agreed_refund_details: VARIANT>>, payment_processor: VARIANT, seller_protection_eligible: BOOLEAN, seller_protection_type: STRING>>, incorrect_transaction_amount: STRUCT<correct_transaction_amount: STRUCT<currency_code: STRING, value: STRING>, correct_transaction_asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, correct_transaction_time: TIMESTAMP>, payment_by_other_means: STRUCT<charge_different_from_original: BOOLEAN, received_duplicate: BOOLEAN, payment_method: STRING, payment_instrument_suffix: STRING>, credit_not_processed: STRUCT<issue_type: STRING, expected_refund: STRUCT<currency_code: STRING, value: STRING>, cancellation_details: STRUCT<cancellation_date: TIMESTAMP, cancellation_number: STRING, cancelled: BOOLEAN, cancellation_mode: STRING>, product_details: STRUCT<description: STRING, product_received: STRING, product_received_time: TIMESTAMP, expected_delivery_date: TIMESTAMP, sub_reasons: ARRAY<STRING>, purchase_url: STRING, return_details: STRUCT<return_time: TIMESTAMP, mode: STRING, receipt: BOOLEAN, return_confirmation_number: STRING, returned: BOOLEAN>>, service_details: STRUCT<description: STRING, service_started: STRING, note: STRING, sub_reasons: ARRAY<STRING>, purchase_url: STRING>, agreed_refund_details: STRUCT<merchant_agreed_refund: BOOLEAN, merchant_agreed_refund_time: TIMESTAMP>>, canceled_recurring_billing: STRUCT<expected_refund: STRUCT<currency_code: STRING, value: STRING>, cancellation_details: STRUCT<cancellation_date: TIMESTAMP, cancellation_number: STRING, cancelled: BOOLEAN, cancellation_mode: STRING>>>, merchandize_dispute_properties: STRUCT<issue_type: STRING, product_details: STRUCT<description: STRING, product_received: STRING, product_received_time: TIMESTAMP, expected_delivery_date: TIMESTAMP, sub_reasons: ARRAY<STRING>, purchase_url: STRING, return_details: STRUCT<return_time: TIMESTAMP, mode: STRING, receipt: BOOLEAN, return_confirmation_number: STRING, returned: BOOLEAN>>, service_details: STRUCT<description: STRING, service_started: STRING, note: STRING, sub_reasons: ARRAY<STRING>, purchase_url: STRING>, cancellation_details: STRUCT<cancellation_date: TIMESTAMP, cancellation_number: STRING, cancelled: BOOLEAN, cancellation_mode: STRING>, return_shipping_address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>>, reported_source: STRING>

evidences

ARRAY<STRUCT<evidence_type: STRING, evidence_info: STRUCT<tracking_info: ARRAY<STRUCT<carrier_name: STRING, carrier_name_other: STRING, tracking_url: STRING, tracking_number: STRING>>, refund_ids: ARRAY<STRING>>, documents: ARRAY<STRUCT<name: STRING, url: STRING>>, notes: STRING, source: STRING, date: TIMESTAMP, item_id: STRING, item_type: STRING, action_info: STRUCT<action: STRING, response_option: STRING, mandatory: BOOLEAN>, dispute_life_cycle_stage: STRING>>

buyer_response_due_date

TIMESTAMP

seller_response_due_date

TIMESTAMP

offer

STRUCT<buyer_requested_amount: STRUCT<currency_code: STRING, value: STRING>, seller_offered_amount: STRUCT<currency_code: STRING, value: STRING>, offer_type: STRING, history: ARRAY<STRUCT<offer_time: TIMESTAMP, actor: STRING, event_type: STRING, offer_type: STRING, offer_amount: STRUCT<currency_code: STRING, value: STRING>, notes: STRING, dispute_life_cycle_stage: STRING>>>

refund_details

STRUCT<allowed_refund_amount: STRUCT<currency_code: STRING, value: STRING>>

communication_details

STRUCT<email: STRING, note: STRING, time_posted: TIMESTAMP>

supporting_info

ARRAY<STRUCT<notes: STRING, documents: ARRAY<STRUCT<name: STRING, url: STRING>>, source: STRING, provided_time: TIMESTAMP, dispute_life_cycle_stage: STRING>>

allowed_response_options

STRUCT<acknowledge_return_item: STRUCT<acknowledgement_types: ARRAY<STRING>>, accept_claim: STRUCT<accept_claim_types: ARRAY<STRING>>, make_offer: STRUCT<offer_types: ARRAY<STRING>>>

links

ARRAY<STRUCT<href: STRING, rel: STRING, method: STRING>>

campo

Tipo de dados

dispute_id

STRING

create_time

TIMESTAMP

update_time

TIMESTAMP

disputed_transactions

ARRAY<STRUCT<buyer_transaction_id: STRING, seller_transaction_id: STRING, reference_id: STRING, create_time: TIMESTAMP, transaction_status: STRING, gross_amount: STRUCT<currency_code: STRING, value: STRING>, gross_asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, invoice_number: STRING, custom: STRING, buyer: STRUCT<name: STRING, email: STRING, payer_id: STRING>, seller: STRUCT<email: STRING, merchant_id: STRING, name: STRING>, items: ARRAY<STRUCT<item_id: STRING, item_name: STRING, item_description: STRING, item_quantity: STRING, partner_transaction_id: STRING, reason: STRING, dispute_amount: STRUCT<currency_code: STRING, value: STRING>, notes: STRING, item_type: STRING, product_details: VARIANT, service_details: VARIANT, booking_details: VARIANT, digital_download_details: VARIANT, cancellation_details: VARIANT, agreed_refund_details: VARIANT>>, payment_processor: VARIANT, seller_protection_eligible: BOOLEAN, seller_protection_type: STRING>>

reason

STRING

status

STRING

dispute_state

STRING

dispute_amount

STRUCT<currency_code: STRING, value: STRING>

dispute_asset

STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>

fee_policy

VARIANT

external_reason_code

STRING

dispute_outcome

STRUCT<outcome_code: STRING, outcome_reason: STRING, amount_refunded: STRUCT<currency_code: STRING, value: STRING>, asset_refunded: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>>

adjudications

ARRAY<STRUCT<type: STRING, adjudication_time: TIMESTAMP, reason: STRING, dispute_life_cycle_stage: STRING>>

money_movements

ARRAY<STRUCT<affected_party: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, initiated_time: TIMESTAMP, type: STRING, reason: STRING>>

fund_movements

ARRAY<STRUCT<party: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, initiated_time: TIMESTAMP, type: STRING, reason: STRING>>

dispute_life_cycle_stage

STRING

dispute_channel

STRING

messages

ARRAY<STRUCT<posted_by: STRING, time_posted: TIMESTAMP, content: STRING, documents: ARRAY<STRUCT<name: STRING, url: STRING>>>>

extensions

STRUCT<merchant_contacted: BOOLEAN, merchant_contacted_outcome: STRING, merchant_contacted_time: TIMESTAMP, merchant_contacted_mode: STRING, buyer_contacted_time: TIMESTAMP, buyer_contacted_channel: STRING, billing_dispute_properties: STRUCT<duplicate_transaction: STRUCT<received_duplicate: BOOLEAN, original_transaction: STRUCT<buyer_transaction_id: STRING, seller_transaction_id: STRING, reference_id: STRING, create_time: TIMESTAMP, transaction_status: STRING, gross_amount: STRUCT<currency_code: STRING, value: STRING>, gross_asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, invoice_number: STRING, custom: STRING, buyer: STRUCT<name: STRING, email: STRING, payer_id: STRING>, seller: STRUCT<email: STRING, merchant_id: STRING, name: STRING>, items: ARRAY<STRUCT<item_id: STRING, item_name: STRING, item_description: STRING, item_quantity: STRING, partner_transaction_id: STRING, reason: STRING, dispute_amount: STRUCT<currency_code: STRING, value: STRING>, notes: STRING, item_type: STRING, product_details: VARIANT, service_details: VARIANT, booking_details: VARIANT, digital_download_details: VARIANT, cancellation_details: VARIANT, agreed_refund_details: VARIANT>>, payment_processor: VARIANT, seller_protection_eligible: BOOLEAN, seller_protection_type: STRING>>, incorrect_transaction_amount: STRUCT<correct_transaction_amount: STRUCT<currency_code: STRING, value: STRING>, correct_transaction_asset: STRUCT<asset_symbol: STRING, quantity: STRING, quantity_in_subunits: STRING, decimals: INT>, correct_transaction_time: TIMESTAMP>, payment_by_other_means: STRUCT<charge_different_from_original: BOOLEAN, received_duplicate: BOOLEAN, payment_method: STRING, payment_instrument_suffix: STRING>, credit_not_processed: STRUCT<issue_type: STRING, expected_refund: STRUCT<currency_code: STRING, value: STRING>, cancellation_details: STRUCT<cancellation_date: TIMESTAMP, cancellation_number: STRING, cancelled: BOOLEAN, cancellation_mode: STRING>, product_details: STRUCT<description: STRING, product_received: STRING, product_received_time: TIMESTAMP, expected_delivery_date: TIMESTAMP, sub_reasons: ARRAY<STRING>, purchase_url: STRING, return_details: STRUCT<return_time: TIMESTAMP, mode: STRING, receipt: BOOLEAN, return_confirmation_number: STRING, returned: BOOLEAN>>, service_details: STRUCT<description: STRING, service_started: STRING, note: STRING, sub_reasons: ARRAY<STRING>, purchase_url: STRING>, agreed_refund_details: STRUCT<merchant_agreed_refund: BOOLEAN, merchant_agreed_refund_time: TIMESTAMP>>, canceled_recurring_billing: STRUCT<expected_refund: STRUCT<currency_code: STRING, value: STRING>, cancellation_details: STRUCT<cancellation_date: TIMESTAMP, cancellation_number: STRING, cancelled: BOOLEAN, cancellation_mode: STRING>>>, merchandize_dispute_properties: STRUCT<issue_type: STRING, product_details: STRUCT<description: STRING, product_received: STRING, product_received_time: TIMESTAMP, expected_delivery_date: TIMESTAMP, sub_reasons: ARRAY<STRING>, purchase_url: STRING, return_details: STRUCT<return_time: TIMESTAMP, mode: STRING, receipt: BOOLEAN, return_confirmation_number: STRING, returned: BOOLEAN>>, service_details: STRUCT<description: STRING, service_started: STRING, note: STRING, sub_reasons: ARRAY<STRING>, purchase_url: STRING>, cancellation_details: STRUCT<cancellation_date: TIMESTAMP, cancellation_number: STRING, cancelled: BOOLEAN, cancellation_mode: STRING>, return_shipping_address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>>, reported_source: STRING>

evidences

ARRAY<STRUCT<evidence_type: STRING, evidence_info: STRUCT<tracking_info: ARRAY<STRUCT<carrier_name: STRING, carrier_name_other: STRING, tracking_url: STRING, tracking_number: STRING>>, refund_ids: ARRAY<STRING>>, documents: ARRAY<STRUCT<name: STRING, url: STRING>>, notes: STRING, source: STRING, date: TIMESTAMP, item_id: STRING, item_type: STRING, action_info: STRUCT<action: STRING, response_option: STRING, mandatory: BOOLEAN>, dispute_life_cycle_stage: STRING>>

buyer_response_due_date

TIMESTAMP

seller_response_due_date

TIMESTAMP

offer

STRUCT<buyer_requested_amount: STRUCT<currency_code: STRING, value: STRING>, seller_offered_amount: STRUCT<currency_code: STRING, value: STRING>, offer_type: STRING, history: ARRAY<STRUCT<offer_time: TIMESTAMP, actor: STRING, event_type: STRING, offer_type: STRING, offer_amount: STRUCT<currency_code: STRING, value: STRING>, notes: STRING, dispute_life_cycle_stage: STRING>>>

refund_details

STRUCT<allowed_refund_amount: STRUCT<currency_code: STRING, value: STRING>>

communication_details

STRUCT<email: STRING, note: STRING, time_posted: TIMESTAMP>

supporting_info

ARRAY<STRUCT<notes: STRING, documents: ARRAY<STRUCT<name: STRING, url: STRING>>, source: STRING, provided_time: TIMESTAMP, dispute_life_cycle_stage: STRING>>

allowed_response_options

STRUCT<acknowledge_return_item: STRUCT<acknowledgement_types: ARRAY<STRING>>, accept_claim: STRUCT<accept_claim_types: ARRAY<STRING>>, make_offer: STRUCT<offer_types: ARRAY<STRING>>>

links

ARRAY<STRUCT<href: STRING, rel: STRING, method: STRING>>

nota

Esta tabela não oferece suporte a SCD tipo 2 porque possui colunas VARIANT.

invoice​

key primária: id Campo do cursor: last_update_time

campo

Tipo de dados

sequence_ts

TIMESTAMP

last_update_time

TIMESTAMP

id

STRING

parent_id

STRING

status

STRING

detail

STRUCT<reference: STRING, currency_code: STRING, note: STRING, terms_and_conditions: STRING, memo: STRING, attachments: ARRAY<STRUCT<id: STRING, reference_url: STRING, content_type: STRING, create_time: TIMESTAMP, size: STRING>>, invoice_number: STRING, invoice_date: DATE, payment_term: STRUCT<term_type: STRING, due_date: DATE>, archived: BOOLEAN, category_code: STRING, group_draft: BOOLEAN, viewed_by_recipient: BOOLEAN, metadata: STRUCT<create_time: TIMESTAMP, created_by: STRING, last_update_time: TIMESTAMP, last_updated_by: STRING, cancel_time: TIMESTAMP, cancelled_by: STRING, first_sent_time: TIMESTAMP, last_sent_time: TIMESTAMP, last_sent_by: STRING, created_by_flow: STRING, recipient_view_url: STRING, invoicer_view_url: STRING, caller_type: STRING>>

invoicer

STRUCT<business_name: STRING, name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>, email_address: STRING, phones: ARRAY<STRUCT<country_code: STRING, national_number: STRING, extension_number: STRING, phone_type: STRING>>, website: STRING, tax_id: STRING, additional_notes: STRING, logo_url: STRING>

primary_recipients

ARRAY<STRUCT<billing_info: STRUCT<business_name: STRING, name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>, email_address: STRING, phones: ARRAY<STRUCT<country_code: STRING, national_number: STRING, extension_number: STRING, phone_type: STRING>>, additional_info: STRING, language: STRING>, shipping_info: STRUCT<business_name: STRING, name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>>>>

additional_recipients

ARRAY<STRING>

items

ARRAY<STRUCT<id: STRING, name: STRING, description: STRING, quantity: STRING, unit_amount: STRUCT<currency_code: STRING, value: STRING>, tax: STRUCT<name: STRING, percent: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, tax_note: STRING>, item_date: DATE, discount: STRUCT<percent: STRING, amount: STRUCT<currency_code: STRING, value: STRING>>, unit_of_measure: STRING>>

configuration

STRUCT<tax_calculated_after_discount: BOOLEAN, tax_inclusive: BOOLEAN, allow_tip: BOOLEAN, partial_payment: STRUCT<allow_partial_payment: BOOLEAN, minimum_amount_due: STRUCT<currency_code: STRING, value: STRING>>, has_conditional_rule: BOOLEAN, template_id: STRING, allow_only_pay_by_bank: BOOLEAN, allow_vba_payments: BOOLEAN, save_item_for_future: BOOLEAN>

amount

STRUCT<currency_code: STRING, value: STRING, breakdown: STRUCT<item_total: STRUCT<currency_code: STRING, value: STRING>, discount: STRUCT<invoice_discount: STRUCT<percent: STRING, amount: STRUCT<currency_code: STRING, value: STRING>>, item_discount: STRUCT<currency_code: STRING, value: STRING>>, tax_total: STRUCT<currency_code: STRING, value: STRING>, shipping: STRUCT<amount: STRUCT<currency_code: STRING, value: STRING>, tax: STRUCT<name: STRING, percent: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, tax_note: STRING>>, custom: STRUCT<label: STRING, amount: STRUCT<currency_code: STRING, value: STRING>>>>

due_amount

STRUCT<currency_code: STRING, value: STRING>

gratuity

STRUCT<currency_code: STRING, value: STRING>

payments

STRUCT<paid_amount: STRUCT<currency_code: STRING, value: STRING>, transactions: ARRAY<STRUCT<type: STRING, payment_id: STRING, payment_date: DATE, payment_date_time: TIMESTAMP, method: STRING, note: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, shipping_info: STRUCT<business_name: STRING, name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>>>>>

refunds

STRUCT<refund_amount: STRUCT<currency_code: STRING, value: STRING>, transactions: ARRAY<STRUCT<type: STRING, refund_id: STRING, recipient_transaction_id: STRING, refund_date: DATE, amount: STRUCT<currency_code: STRING, value: STRING>, method: STRING>>>

links

ARRAY<STRUCT<href: STRING, rel: STRING, method: STRING>>

unilateral

BOOLEAN

campo

Tipo de dados

sequence_ts

TIMESTAMP

last_update_time

TIMESTAMP

id

STRING

parent_id

STRING

status

STRING

detail

STRUCT<reference: STRING, currency_code: STRING, note: STRING, terms_and_conditions: STRING, memo: STRING, attachments: ARRAY<STRUCT<id: STRING, reference_url: STRING, content_type: STRING, create_time: TIMESTAMP, size: STRING>>, invoice_number: STRING, invoice_date: DATE, payment_term: STRUCT<term_type: STRING, due_date: DATE>, archived: BOOLEAN, category_code: STRING, group_draft: BOOLEAN, viewed_by_recipient: BOOLEAN, metadata: STRUCT<create_time: TIMESTAMP, created_by: STRING, last_update_time: TIMESTAMP, last_updated_by: STRING, cancel_time: TIMESTAMP, cancelled_by: STRING, first_sent_time: TIMESTAMP, last_sent_time: TIMESTAMP, last_sent_by: STRING, created_by_flow: STRING, recipient_view_url: STRING, invoicer_view_url: STRING, caller_type: STRING>>

invoicer

STRUCT<business_name: STRING, name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>, email_address: STRING, phones: ARRAY<STRUCT<country_code: STRING, national_number: STRING, extension_number: STRING, phone_type: STRING>>, website: STRING, tax_id: STRING, additional_notes: STRING, logo_url: STRING>

primary_recipients

ARRAY<STRUCT<billing_info: STRUCT<business_name: STRING, name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>, email_address: STRING, phones: ARRAY<STRUCT<country_code: STRING, national_number: STRING, extension_number: STRING, phone_type: STRING>>, additional_info: STRING, language: STRING>, shipping_info: STRUCT<business_name: STRING, name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>>>>

additional_recipients

ARRAY<STRING>

items

ARRAY<STRUCT<id: STRING, name: STRING, description: STRING, quantity: STRING, unit_amount: STRUCT<currency_code: STRING, value: STRING>, tax: STRUCT<name: STRING, percent: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, tax_note: STRING>, item_date: DATE, discount: STRUCT<percent: STRING, amount: STRUCT<currency_code: STRING, value: STRING>>, unit_of_measure: STRING>>

configuration

STRUCT<tax_calculated_after_discount: BOOLEAN, tax_inclusive: BOOLEAN, allow_tip: BOOLEAN, partial_payment: STRUCT<allow_partial_payment: BOOLEAN, minimum_amount_due: STRUCT<currency_code: STRING, value: STRING>>, has_conditional_rule: BOOLEAN, template_id: STRING, allow_only_pay_by_bank: BOOLEAN, allow_vba_payments: BOOLEAN, save_item_for_future: BOOLEAN>

amount

STRUCT<currency_code: STRING, value: STRING, breakdown: STRUCT<item_total: STRUCT<currency_code: STRING, value: STRING>, discount: STRUCT<invoice_discount: STRUCT<percent: STRING, amount: STRUCT<currency_code: STRING, value: STRING>>, item_discount: STRUCT<currency_code: STRING, value: STRING>>, tax_total: STRUCT<currency_code: STRING, value: STRING>, shipping: STRUCT<amount: STRUCT<currency_code: STRING, value: STRING>, tax: STRUCT<name: STRING, percent: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, tax_note: STRING>>, custom: STRUCT<label: STRING, amount: STRUCT<currency_code: STRING, value: STRING>>>>

due_amount

STRUCT<currency_code: STRING, value: STRING>

gratuity

STRUCT<currency_code: STRING, value: STRING>

payments

STRUCT<paid_amount: STRUCT<currency_code: STRING, value: STRING>, transactions: ARRAY<STRUCT<type: STRING, payment_id: STRING, payment_date: DATE, payment_date_time: TIMESTAMP, method: STRING, note: STRING, amount: STRUCT<currency_code: STRING, value: STRING>, shipping_info: STRUCT<business_name: STRING, name: STRUCT<prefix: STRING, given_name: STRING, surname: STRING, middle_name: STRING, suffix: STRING, alternate_full_name: STRING, full_name: STRING>, address: STRUCT<address_line_1: STRING, address_line_2: STRING, address_line_3: STRING, admin_area_4: STRING, admin_area_3: STRING, admin_area_2: STRING, admin_area_1: STRING, postal_code: STRING, country_code: STRING, address_details: STRUCT<street_number: STRING, street_name: STRING, street_type: STRING, delivery_service: STRING, building_name: STRING, sub_building: STRING>>>>>>

refunds

STRUCT<refund_amount: STRUCT<currency_code: STRING, value: STRING>, transactions: ARRAY<STRUCT<type: STRING, refund_id: STRING, recipient_transaction_id: STRING, refund_date: DATE, amount: STRUCT<currency_code: STRING, value: STRING>, method: STRING>>>

links

ARRAY<STRUCT<href: STRING, rel: STRING, method: STRING>>

unilateral

BOOLEAN

balance​

Key primária: account_id, currency Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

currency

STRING

primary

BOOLEAN

total_balance

STRUCT<currency_code: STRING, value: STRING>

available_balance

STRUCT<currency_code: STRING, value: STRING>

withheld_balance

STRUCT<currency_code: STRING, value: STRING>

account_id

STRING

as_of_time

TIMESTAMP

last_refresh_time

TIMESTAMP

campo

Tipo de dados

currency

STRING

primary

BOOLEAN

total_balance

STRUCT<currency_code: STRING, value: STRING>

available_balance

STRUCT<currency_code: STRING, value: STRING>

withheld_balance

STRUCT<currency_code: STRING, value: STRING>

account_id

STRING

as_of_time

TIMESTAMP

last_refresh_time

TIMESTAMP

product​

Chave key: id Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

id

STRING

name

STRING

description

STRING

type

STRING

category

STRING

image_url

STRING

home_url

STRING

payee

STRUCT<merchant_id: STRING, display_data: STRUCT<business_phone: STRUCT<country_code: STRING, national_number: STRING>>>

create_time

TIMESTAMP

update_time

TIMESTAMP

links

ARRAY<STRUCT<href: STRING, rel: STRING, method: STRING>>

campo

Tipo de dados

id

STRING

name

STRING

description

STRING

type

STRING

category

STRING

image_url

STRING

home_url

STRING

payee

STRUCT<merchant_id: STRING, display_data: STRUCT<business_phone: STRUCT<country_code: STRING, national_number: STRING>>>

create_time

TIMESTAMP

update_time

TIMESTAMP

links

ARRAY<STRUCT<href: STRING, rel: STRING, method: STRING>>

billing_plan​

Chave key: id Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

id

STRING

product_id

STRING

name

STRING

status

STRING

description

STRING

usage_type

STRING

version

INT

quantity_supported

BOOLEAN

billing_cycles

ARRAY<STRUCT<sequence: INT, tenure_type: STRING, total_cycles: INT, frequency: STRUCT<interval_unit: STRING, interval_count: INT>, pricing_scheme: STRUCT<version: INT, pricing_model: STRING, fixed_price: STRUCT<currency_code: STRING, value: STRING>, tiers: ARRAY<STRUCT<starting_quantity: STRING, ending_quantity: STRING, amount: STRUCT<currency_code: STRING, value: STRING>>>, create_time: TIMESTAMP, update_time: TIMESTAMP>>>

payment_preferences

STRUCT<auto_bill_outstanding: BOOLEAN, setup_fee: STRUCT<currency_code: STRING, value: STRING>, setup_fee_failure_action: STRING, payment_failure_threshold: INT, service_type: STRING>

taxes

STRUCT<percentage: STRING, inclusive: BOOLEAN>

payee

STRUCT<merchant_id: STRING, display_data: STRUCT<business_email: STRING, business_phone: STRUCT<country_code: STRING, national_number: STRING>>>

create_time

TIMESTAMP

update_time

TIMESTAMP

links

ARRAY<STRUCT<href: STRING, rel: STRING, method: STRING, encType: STRING>>

campo

Tipo de dados

id

STRING

product_id

STRING

name

STRING

status

STRING

description

STRING

usage_type

STRING

version

INT

quantity_supported

BOOLEAN

billing_cycles

ARRAY<STRUCT<sequence: INT, tenure_type: STRING, total_cycles: INT, frequency: STRUCT<interval_unit: STRING, interval_count: INT>, pricing_scheme: STRUCT<version: INT, pricing_model: STRING, fixed_price: STRUCT<currency_code: STRING, value: STRING>, tiers: ARRAY<STRUCT<starting_quantity: STRING, ending_quantity: STRING, amount: STRUCT<currency_code: STRING, value: STRING>>>, create_time: TIMESTAMP, update_time: TIMESTAMP>>>

payment_preferences

STRUCT<auto_bill_outstanding: BOOLEAN, setup_fee: STRUCT<currency_code: STRING, value: STRING>, setup_fee_failure_action: STRING, payment_failure_threshold: INT, service_type: STRING>

taxes

STRUCT<percentage: STRING, inclusive: BOOLEAN>

payee

STRUCT<merchant_id: STRING, display_data: STRUCT<business_email: STRING, business_phone: STRUCT<country_code: STRING, national_number: STRING>>>

create_time

TIMESTAMP

update_time

TIMESTAMP

links

ARRAY<STRUCT<href: STRING, rel: STRING, method: STRING, encType: STRING>>

Recursos necessários do aplicativo PayPal​

O aplicativo da API REST do PayPal deve ter os seguintes recursos habilitados. Para alterá-los, abra o aplicativo em Apps & Credentials no Painel de Desenvolvedor do PayPal e atualize a seção recurso .

Recurso

Obrigatório para

Pesquisa de transações

transaction, balance

Faturamento

invoice

Disputas de cliente

dispute

inscrição

product, billing_plan

Recurso

Obrigatório para

Pesquisa de transações

transaction, balance

Faturamento

invoice

Disputas de cliente

dispute

inscrição

product, billing_plan