Detalhes da Conexão do PayPal

Introdução

Versão do conector

Esta documentação é baseada na versão 22.0.8510 do conector.

Começando

Suporte à versão do PayPal

O conector usa a API SOAP do PayPal para exibir exibições de transações e a API REST para exibir todas as outras exibições.

Estabelecendo uma Conexão

O provedor exibe tabelas de duas APIs do PayPal. As APIs usam diferentes métodos de autenticação.

Para escolher a API com a qual deseja trabalhar, defina o Schema propriedade para REST ou SOAP. Por padrão, o esquema SOAP será usado.

• A API REST usa o padrão OAuth. Para autenticar na API REST, você precisará definir o AuthScheme para OAuth, o OAuthClientId, e OAuthClientSecret propriedades. Consulte Conectando-se à API REST Para maiores informações.
• A API SOAP requer credenciais de API de assinatura. Para autenticar na API SOAP, você precisará definir o AuthScheme para Básico, defina Username, Password, e Signature propriedades. Você gera essas credenciais de API ao ativar a API SOAP. Consulte Conectando-se à API SOAP Para maiores informações.

Para fins de teste, defina UseSandbox para verdadeiro e use as credenciais do Sandbox.

Conectando-se à API SOAP

Usando Credenciais de API para Chamadas de API SOAP

Você pode usar a API SOAP para recuperar todas as transações da conta atual. A API SOAP usa o tipo Signature API-credentials, que tem três valores de credencial:

• Nome de usuário da API
• Senha da API
• Assinatura da API

Para gerar as credenciais da API:

1. Faça login em sua conta comercial do PayPal e selecione Profile > My Selling Tools.
2. Na seção Venda Online, clique em Update para o item API Access.
3. Para gerar a assinatura da API, clique em Request API Credentials na página de acesso à API.
4. Selecione Request API Signature e clique Agree and Submit para gerar a assinatura da API.

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

• User: Defina isso como o nome de usuário da API.
• Password: Defina isso como a senha da API.
• Signature: Defina isso para a assinatura.
• UseSandbox: Defina como true se estiver usando credenciais de sandbox.

Conectando-se à API REST

Criar um Aplicativo

Para registrar um aplicativo e obter as credenciais do cliente OAuth, o ID do cliente e o segredo do cliente:

1. Faça login em sua conta de desenvolvedor do PayPal e em Meus aplicativos e credenciais (em Painel).
2. Role até a seção Aplicativos da API REST e clique em Create App.
3. Digite o nome do aplicativo.
4. Na lista suspensa, selecione a conta do sandbox que será usada para obter os dados.

O PayPal gera um conjunto de sandbox e chaves OAuth ao vivo para o aplicativo. As credenciais do sandbox são mostradas após a criação do aplicativo. Para as credenciais ao vivo, selecione o Live opção.

As credenciais do sandbox serão usadas para obter dados apenas para a conta do sandbox selecionada ao criar o aplicativo, enquanto as credenciais do Live serão usadas para obter dados apenas para a conta do desenvolvedor usada para criar este aplicativo.

Autenticar no PayPal

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca OAuth e definir manualmente o OAuthAccessToken propriedade de conexão.
• OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
• UseSandbox: Defina como true se estiver usando credenciais de sandbox.

Quando você se conecta, o conector conclui o processo OAuth.

1. Troca o OAuthClientId e OAuthClientSecret para o OAuthAccessToken.
2. Atualiza o token de acesso quando ele expira.
3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector do PayPal.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visualizações definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Processamento de consulta

O conector transfere o máximo possível do processamento da instrução SELECT para o PayPal e, em seguida, processa o restante da consultar na memória (do lado do cliente).

Consulte Processamento de consultas Para maiores informações.

Visualizações Definidas pelo Usuário

O Jitterbit Connector for PayPal permite definir uma mesa virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

• Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
• declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

• Cada elemento raiz define o nome de uma visualização.
• Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Payments WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Definindo Exibições Usando Instruções DDL

O conector também é capaz de criar e alterar o esquema por meio de instruções DDL, como CREATE LOCAL VIEW, ALTER LOCAL VIEW e DROP LOCAL VIEW.

Criar uma Visualização

Para criar uma nova visualização usando instruções DDL, forneça o nome da visualização e a consultar da seguinte forma:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

Se não existir nenhum arquivo JSON, o código acima criará um. A exibição é então criada no arquivo de configuração JSON e agora pode ser descoberta. O local do arquivo JSON é especificado pelo UserDefinedViews propriedade de conexão.

Alterar uma Visualização

Para alterar uma exibição existente, forneça o nome de uma exibição existente ao lado da nova consultar que você gostaria de usar:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

A visualização é então atualizada no arquivo de configuração JSON.

Solte uma Visualização

Para descartar uma exibição existente, forneça o nome de um esquema existente ao lado da nova consultar que você gostaria de usar.

DROP LOCAL VIEW [MyViewName]

Isso remove a visualização do arquivo de configuração JSON. Não pode mais ser consultado.

Esquema para Exibições Definidas pelo Usuário

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões bem mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados

O Jitterbit Connector for PayPal modela duas APIs do PayPal como bancos de dados relacionais, a API REST e a API SOAP. Colocou o Schema e use as informações em cada seção para selecionar a API adequada com base nas necessidades do seu projeto.

Usando a API REST

A API REST é a API mais recente e está se tornando mais popular entre os usuários do PayPal. No entanto, a API REST lista apenas as transações e ações feitas por meio da API REST e exclui a interface do usuário e a API SOAP.

Consulte Modelo de dados REST para as entidades disponíveis na API REST.

Usando a API SOAP

A API SOAP (Classic) possui informações completas sobre transações, que incluem transações criadas a partir da interface do usuário, API REST e API SOAP.

Consulte Modelo de dados SOAP para as entidades disponíveis na API SOAP.

Modelo de Dados REST

O Jitterbit Connector for PayPal modela as APIs REST do PayPal como exibições de banco de dados e procedimentos armazenados. Eles são definidos em arquivos de esquema, que são arquivos de configuração simples baseados em texto que facilitam a personalização dos esquemas.

Esta seção fornece as limitações e requisitos da API para o modelo de dados REST; você pode usar o SupportEnhancedSQL recurso, definido por padrão, para contornar a maioria dessas limitações.

Visualizações

Visualizações são tabelas que não podem ser modificadas. Normalmente, os dados somente leitura são mostrados como exibições.

Procedimentos Armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para o PayPal. Eles podem ser usados para acessar outras funcionalidades no PayPal não exibidas nas Visualizações.

Limitações da API REST do PayPal

Existem algumas limitações na API REST do PayPal. Por exemplo, ele não fornece nenhuma maneira de listar todos os pedidos/pagamentos, portanto, para consultar as exibições relacionadas, como OrderItems, Detalhes do pedido, Pagamentos deve conhecer o respetivo ID e especificá-lo.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto.

Visualizações dinâmicas, como consultas expostas como visualizações e visualizações para procurar combinações específicas de itens de trabalho project_team são suportadas.

Conector Jitterbit para Visualizações do PayPal

Detalhes da Autorização

Detalhes da consulta sobre autorizações.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é o Id, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor e recuperam detalhes de uma autorização específica.

SELECT * FROM AuthorizationDetails WHERE Id = '70K15739YA1955155'

SELECT * FROM AuthorizationDetails WHERE ID IN ('70K15739YA1955155', '70K15739YA1955156')

Colunas

Saldos

Liste todos os saldos não criptográficos.

Informações Específicas da Tabela

Selecione

Essa exibição retorna uma lista de disputas para o usuário autenticado.

Os seguintes filtros são suportados pela API do PayPal:

• Moeda
• AsOfTime

Os filtros suportam apenas o operador =.

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor.

• A consultar a seguir recupera detalhes de uma moeda específica:

  SELECT * FROM Balances WHERE Currency = 'USD'
  

• A consultar a seguir retorna detalhes dos registros de Saldo criados antes da data e hora especificadas:

  SELECT * FROM Balances WHERE AsOfTime = '2022-01-09 20:59:59.0'
  

Colunas

CaptureDetails

Detalhes da consulta sobre um pagamento capturado.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é o Id, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor e recuperam detalhes de um Capture específico.

SELECT * FROM CaptureDetails WHERE Id = '9G02572041588110H'

SELECT * FROM CaptureDetails WHERE ID IN ('9G02572041588110H', '9G02572041588111H')

Colunas

Detalhes do Cartão de Crédito

Consultar detalhes sobre o instrumento de financiamento do pagador, como Cartão de Crédito ou token que represente um Cartão de Crédito.

Informações Específicas da Tabela

Selecione

Esta exibição retorna uma lista de cartões de crédito ou detalhes de um cartão específico.

Os seguintes filtros são suportados pela API do PayPal:

• Eu ia
• CreateTime
• ID do comerciante
• ExternalCardId
• ExternalCustomerId

O filtro CreateTime suporta os operadores >, >=, <, <= e =, enquanto os outros filtros suportam apenas o operador =.

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor.

• A consultar a seguir recupera detalhes de um cartão de crédito específico:

  SELECT * FROM CreditCardDetails WHERE ID  = 'CARD-19H02474E2775740PKZYWVVI'
  

• A consultar a seguir retorna detalhes de registros de cartão de crédito criados após a data especificada:

  SELECT * FROM CreditCardDetails WHERE CreateTime>'2016-01-01'
  

Colunas

CryptoBalances

Liste todos os saldos de criptografia.

Informações Específicas da Tabela

Selecione

Essa exibição retorna uma lista de disputas para o usuário autenticado.

Os seguintes filtros são suportados pela API do PayPal:

• AsOfTime

Os filtros suportam apenas o operador =.

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor.

• A consultar a seguir retorna detalhes dos registros de Saldo criados antes da data e hora especificadas:

  SELECT * FROM CryptoBalances WHERE AsOfTime = '2022-01-09 20:59:59.0'
  

Colunas

Detalhes da Disputa

Comerciantes, parceiros e desenvolvedores externos do PayPal podem usar a API de disputas do PayPal para gerenciar disputas.

Informações Específicas da Tabela

Selecione

Essa exibição retorna uma lista de disputas com informações detalhadas para o usuário autenticado.

Os seguintes filtros são suportados pela API do PayPal:

• ID da disputa

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor.

• A consultar a seguir recupera detalhes de uma disputa específica:

  SELECT * FROM DisputeDetails WHERE DisputeId = 'PP-D-12345'
  

Colunas

Disputas

Comerciantes, parceiros e desenvolvedores externos do PayPal podem usar a API de disputas do PayPal para gerenciar disputas.

Informações Específicas da Tabela

Selecione

Essa exibição retorna uma lista de disputas para o usuário autenticado.

Os seguintes filtros são suportados pela API do PayPal:

• ID da disputa
• Estado da Disputa
• CreateTime

O filtro CreateTime suporta os operadores >, >=, <, <= e =, enquanto os outros filtros suportam apenas o operador =.

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor.

• A consultar a seguir recupera detalhes de uma disputa específica:

  SELECT * FROM Disputes WHERE DisputeId = 'PP-D-12345'
  

• A consultar a seguir retorna detalhes dos registros de Disputa criados após a data especificada:

  SELECT * FROM Disputes WHERE CreateTime>'2016-01-01'
  

Colunas

Transações de Disputa

Comerciantes, parceiros e desenvolvedores externos do PayPal podem usar a API de disputas do PayPal para gerenciar disputas.

Informações Específicas da Tabela

Selecione

Esta exibição retorna uma lista de transações com detalhes para uma disputa específica.

Os seguintes filtros são suportados pela API do PayPal:

• ID da disputa

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor.

• A consultar a seguir recupera os detalhes da transação para uma disputa específica:

  SELECT * FROM DisputeTransactions WHERE DisputeId = 'PP-D-12345'
  

Colunas

Faturas

Consulta de Faturas no PayPal.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é o ID. O processamento do lado do servidor é compatível apenas com o operador '='.

SELECT * FROM Invoices WHERE Id='INV2-LV8Z-5XH2-L4Z6-7LQ4'

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Colunas

Notificações

Consulte a lista de tipos de eventos inscritos em um Webhook.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é o WebhookId, que oferece suporte apenas ao operador =. Este é um parâmetro obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, a consultar a seguir é processada no lado do servidor e recupera a lista de Notificações para o Webhook especificado.

SELECT * FROM Notifications WHERE WebhookId='8BU398853V564980H'

Colunas

Detalhes do Pedido

Detalhes da consulta sobre um pedido.

Informações Específicas da Tabela

Selecione

Observação: A API REST do PayPal não nos fornece uma maneira de listar todos os OrderId-s, portanto, você deve especificá-la. Se você precisar desse caso de uso, é recomendável usar as Transações e Detalhes da transação visualizações no esquema SOAP.
O único filtro compatível com a API do PayPal é o Id, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor e recuperam detalhes de um pedido específico.

SELECT * FROM OrderDetails WHERE Id = 'O-1HE90236LH9332431'

SELECT * FROM OrderDetails WHERE ID IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Colunas

Itens de Ordem

Obtenha os itens em um pedido.

Informações Específicas da Tabela

Selecione

Observação: A API REST do PayPal não nos fornece uma maneira de listar todos os OrderId-s, portanto, você deve especificá-la. Se você precisar desse caso de uso, é recomendável usar as Transações e Itens de Transação visualizações no esquema SOAP.
O único filtro compatível com a API do PayPal é OrderId, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor e recuperam detalhes de um pedido específico.

SELECT * FROM OrderItems WHERE OrderId = 'O-1HE90236LH9332431'

SELECT * FROM OrderItems WHERE OrderId IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Colunas

Pagamentos

Detalhes da consulta sobre pagamentos autorizados.

Informações Específicas da Tabela

Selecione

Os únicos filtros com suporte são ID e OrderId. Filtros suportam apenas o operador = O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, a consultar a seguir é processada no lado do servidor e recupera os pagamentos que foram criados após a data especificada.

SELECT * FROM Payments WHERE ID > 'P-41250-2' AND OrderId =  'O-123550-05'

Colunas

PagamentoTransações

Consulte os detalhes da transação, incluindo o valor e os detalhes do item.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é PaymentId, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor e recuperam uma lista de transações para o pagamento especificado.

SELECT * FROM PaymentTransactions WHERE PaymentId='PAY-6SL93120VR4146201KZYWPVY'

SELECT * FROM PaymentTransactions WHERE PaymentId IN ('PAY-6SL93120VR4146201KZYWPVY', 'PAY-6SL93120VR0000201KZYWPVY')

Colunas

Detalhes do Pagamento

Recupere detalhes sobre Pagamentos.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é PayoutBatchId, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, a consultar a seguir é processada no lado do servidor e recupera detalhes de um Pagamento específico.

SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'

Colunas

Itens de Pagamento

Recupere itens de pagamento de um Pagamento.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é PayoutBatchId, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, a consultar a seguir é processada no lado do servidor e recupera todos os itens de pagamento para um pagamento específico.

SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2'

Colunas

Planos

Liste os planos de cobrança.

Informações Específicas da Tabela

Selecione

Essa exibição retorna uma lista de planos de assinatura para o usuário autenticado.

Os seguintes filtros são suportados pela API do PayPal:

• Eu ia
• ID do produto

SELECT * FROM Plans
SELECT * FROM Plans WHERE Id='1234'
SELECT * FROM Plans WHERE ProductId='1234'

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Colunas

Detalhes do Reembolso

Detalhes da consulta sobre um Reembolso específico.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é o Id, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor e recuperam detalhes de um Reembolso específico.

SELECT * FROM RefundDetails WHERE Id = '4W92068757818534U'

SELECT * FROM RefundDetails WHERE ID IN ('4W92068757818534U', '4W91234757818534U')

Colunas

Detalhes da Venda

Detalhes da consulta sobre uma transação de venda.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é o Id, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Por exemplo, as consultas a seguir são processadas no lado do servidor e recuperam detalhes de uma venda específica.

SELECT * FROM SaleDetails WHERE Id = '6M2430095X488331A'

SELECT * FROM SaleDetails WHERE ID IN ('6M2430095X488331A', '6M2410805X488331A')

Colunas

Assinaturas

Obtenha detalhes de cobrança e assinatura.

Informações Específicas da Tabela

Selecione

O único filtro compatível com a API do PayPal é o Id, que é obrigatório. O conector processa outros filtros do lado do cliente dentro do conector.

SELECT * FROM Subscriptions WHERE Id='1234'

NOTE: Podemos obter o SubscriptionId criando a assinatura usando o procedimento armazenado CreateSubscription.

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Colunas

Transações de Assinatura

Lista transações para uma assinatura.

Informações Específicas da Tabela

Selecione

Esta exibição retorna uma lista de transações com detalhes para uma assinatura específica.

Os seguintes filtros são suportados pela API do PayPal:

• ID de Inscrição
• Hora de início
• Fim do tempo

SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234'
SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234' AND StartTime = '2018-01-21T07:50:20.940Z' AND EndTime = '2018-08-21T07:50:20.940Z'

NOTE: 1. SubscriptionId, StartTime e EndTime são os parâmetros necessários para esta exibição e, se StartTime e EndTime não forem especificados na consultar, os valores padrão serão atribuídos a partir do código. 2. Podemos obter o SubscriptionId criando a assinatura usando o procedimento armazenado CreateSubscription.

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Relatórios de Transações

Lista relatórios de transações.

Informações Específicas da Tabela

Selecione

Os filtros suportados pela API do PayPal são StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. O processamento do lado do servidor é compatível apenas com o operador '='.

SELECT * FROM TransactionReports WHERE StartDate='2021-09-06 12:12:12' AND EndDate='2021-09-11 12:12:12'

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

TransactionReportsCartInfoItemDetails

Liste as informações do carrinho de relatórios de transações.

Informações Específicas da Tabela

Selecione

Os filtros suportados pela API do PayPal são StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. O processamento do lado do servidor é compatível apenas com o operador '='.

SELECT * FROM TransactionReportsCartInfoItemDetails WHERE StartDate='2021-09-06 12:12:12' AND EndDate='2021-09-11 12:12:12'

O conector processa outros filtros do lado do cliente dentro do conector. Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

TransaçãoRelatóriosIncentivoDetalhes

Listar Detalhes de Incentivo de Relatórios de Transação.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Webhooks

Consulte a lista de Webhooks.

Informações Específicas da Tabela

Selecione

A API do PayPal não oferece suporte a nenhum filtro nesta tabela. No entanto, as projeções são suportadas. Todos os filtros são processados no lado do cliente dentro do conector.

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso.

Colunas

Procedimentos Armazenados

Procedimentos armazenados* são interfaces semelhantes a funções que estendem a funcionalidade do conector além das simples operações SELECT com o PayPal.

Procedimentos armazenados* aceitar uma lista de parâmetros, executar a função pretendida e, em seguida, retornar, se aplicável, quaisquer dados de resposta relevantes do PayPal, junto com uma indicação de se o procedimento foi bem-sucedido ou falhou.

Conector Jitterbit para Procedimentos Armazenados do PayPal

CriarPagamentos

Faz pagamentos no PayPal.

Informações Específicas da Tabela

Itens de pagamento

Você não pode criar um pagamento sem itens de pagamento. Para criar itens de pagamento, você deve inserir dados usando um agregado JSON ou por meio de uma tabela temporária chamada 'PayoutItem#TEMP'. Consulte os exemplos a seguir para obter mais informações.

Exemplo: criar pagamentos usando JSON agregado

EXECUTE CreatePayouts SenderBatchId='1247', EmailSubject='You have a payout!', EmailMessage='You have received a payout! Thanks for using our service!', PayoutItem='[{\n" +
          "\"recipient_type\": \"EMAIL\",\n" +
          "\"amount\": {\n" +
          "\"value\": \"0.0\",\n" +
          "\"currency\": \"USD\"\n" +
          "},\n" +
          "\"note\": \"Thanks for your patronage3333!\",\n" +
          "\"receiver\": \"receiver@example.com\",\n" +
          "\"sender_item_id\": \"201403140001\"\n" +
          "}, {\n" +
          "\"recipient_type\": \"PHONE\",\n" +
          "\"amount\": {\n" +
          "\"value\": \"0.0\",\n" +
          "\"currency\": \"USD\"\n" +
          "\t},\n" +
          "\"note\": \"Thanks for your support!\",\n" +
          "\"receiver\": \"91-734-234-1234\",\n" +
          "\"sender_item_id\": \"201403140002\"\n" +
          "}\n" +
"]'

Exemplo: criar pagamentos usando tabela temporária

Você primeiro precisa inserir em PayoutItem#TEMP para criar itens de pagamento.

INSERT INTO PayoutItem#TEMP(RecipientType,AmountValue,AmountCurrency,Note,SenderItemId,Receiver) VALUES ('EMAIL','3.2','USD','Thanks for your patronage!', '201403140001', 'receiver@example.com')
INSERT INTO PayoutItem#TEMP(RecipientType,AmountValue,AmountCurrency,Note,SenderItemId,Receiver) VALUES ('PHONE','8.98','USD','Thanks for your support!', '201403140002', '91-734-234-1234')

Executar

Depois de criar pelo menos um item de pagamento, você pode executar o procedimento armazenado.

EXECUTE CreatePayouts SenderBatchId='123', EmailSubject='You have a payout!', EmailMessage='You have received a payout! Thanks for using our service!'

As seguintes colunas são necessárias para criar um item de pagamento:

• Tipo de Destinatário
• QuantidadeValor
• Valor em moeda
• SenderItemId
• Receptor

Entrada

Colunas do conjunto de resultados

CriarAssinatura

Crie uma assinatura para o PayPal.

Procedimento Armazenado* Informações Específicas

O CreateSubscription procedimento armazenado* exige que o PlanId crie uma assinatura do PayPal.

EXECUTE CreateSubscription PlanId='P-5ML4271244454362WXNWU5NQ', StartTime='2021-11-01T00:00:00Z', ShippingAmount='{\n" +
          "    \"currency_code\": \"USD\",\n" +
          "    \"value\": \"10.00\"\n" +
          "  }', subscriber='{\n" +
          "    \"name\": {\n" +
          "      \"given_name\": \"John\",\n" +
          "      \"surname\": \"Doe\"\n" +
          "    },\n" +
          "    \"email_address\": \"customer@example.com\",\n" +
          "    \"shipping_address\": {\n" +
          "      \"name\": {\n" +
          "        \"full_name\": \"John Doe\"\n" +
          "      },\n" +
          "      \"address\": {\n" +
          "        \"address_line_1\": \"2211 N First Street\",\n" +
          "        \"address_line_2\": \"Building 17\",\n" +
          "        \"admin_area_2\": \"San Jose\",\n" +
          "        \"admin_area_1\": \"CA\",\n" +
          "        \"postal_code\": \"95131\",\n" +
          "        \"country_code\": \"US\"\n" +
          "      }\n" +
          "    }\n" +
"  }'

As seguintes colunas são necessárias para criar uma assinatura:

• PlanId

Entrada

Colunas do conjunto de resultados

GetOAuthAccessToken

Obtém o token de acesso OAuth do PayPal.

Colunas do conjunto de resultados

RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com vários serviços do PayPal.

Colunas do conjunto de resultados

SendInvoice

Envie uma Fatura, por Id, para um cliente.

Entrada

Modelo de dados SOAP

O Jitterbit Connector for PayPal modela as APIs SOAP do PayPal como banco de dados Visualizações. Normalmente, os dados somente leitura são mostrados como exibições. Eles são definidos em arquivos de esquema, que são arquivos de configuração simples baseados em texto que facilitam a personalização dos esquemas.

Esta seção fornece as limitações e requisitos da API para o modelo de dados SOAP; você pode usar o SupportEnhancedSQL recurso, definido por padrão, para contornar a maioria dessas limitações.

Visualizações

Visualizações são tabelas que não podem ser modificadas. Normalmente, os dados somente leitura são mostrados como exibições.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na maneira como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto.

Visualizações dinâmicas, como consultas expostas como visualizações e visualizações para procurar combinações específicas de itens de trabalho project_team são suportadas.

Conector Jitterbit para visualizações do PayPal

Balance

Veja todas as moedas da conta e seus saldos.

Colunas

BalanceAffecting

Consultar as transações que afetam o saldo da conta.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

BalanceTransfer

Consultar Transações envolvendo Transferências de Saldo.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

BillPay

Transações de consulta envolvendo transações de boleto.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

CurrencyConversions

Consultar Transações envolvendo Conversões de Moeda.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Dividendo

Consultar Transações envolvendo Dividendos.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

ECheck

Transações de consulta envolvendo eChecks.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Taxa

Consultar Transações envolvendo Tarifas.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Fundos adicionados

Consulta Transações geradas quando os fundos são adicionados ao saldo.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Fundos retirados

Consulta Transações geradas quando os fundos são retirados do saldo.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

MassPay

Consultar transações de pagamentos em massa.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

MoneyRequest

Consultar transações de solicitação de dinheiro.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Recebido

Consultar transações de pagamentos recebidos.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Referral

Transações de consulta envolvendo referências.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Reembolso

Consultar Transações envolvendo Reembolsos.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Reversão

Transações de consulta envolvendo Estornos de BillPay.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Enviado

Consultar transações de pagamentos enviados.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Frete

Consultar Transações envolvendo Taxas de Remessa UPS.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Assinatura

Transações de Consulta envolvendo Assinaturas.

Colunas