Detalles de Conexión de PayPal

Introducción

Versión del conector

Esta documentación se basa en la versión 22.0.8510 del conector.

Empezando

Compatibilidad con la versión de PayPal

El conector utiliza la API SOAP de PayPal para mostrar vistas de transacciones y la API REST para mostrar todas las demás vistas.

Establecer una Conexión

El proveedor muestra tablas de dos APIs de PayPal. Las APIs utilizan diferentes métodos de autenticación.

Para elegir la API con la que desea trabajar, configure Schema propiedad de REST o SOAP. De forma predeterminada, se utilizará el esquema SOAP.

• La API REST utiliza el estándar OAuth. Para autenticarse en la API REST, deberá configurar AuthScheme a OAuth, el OAuthClientId, y OAuthClientSecret propiedades. Consulte Conexión a la API REST para más información.
• La API de SOAP requiere credenciales de API de firma. Para autenticarse en la API de SOAP, deberá configurar AuthScheme a Básico, configure Username, Password, y Signature propiedades. Usted genera estas credenciales de API cuando habilita la API de SOAP. Consulte Conexión a la API de SOAP para más información.

Para fines de prueba, configure UseSandbox para verificar y usar las credenciales de Sandbox.

Conexión a la API de SOAP

Uso de Credenciales de API para Llamadas de API SOAP

Puede utilizar la API de SOAP para recuperar todas las transacciones de la cuenta actual. La API SOAP utiliza el tipo Signature API-credentials, que tiene tres valores de credencial:

• Nombre de usuario de la API
• Contraseña API
• Firma API

Para generar las credenciales de la API:

1. Inicie sesión en su cuenta comercial de PayPal y seleccione Profile > My Selling Tools.
2. En la sección Vender en línea, haga clic en Update para el elemento Acceso API.
3. Para generar la firma API, haga clic en Request API Credentials en la página Acceso a la API.
4. Seleccione Request API Signature y haga clic en Agree and Submit para generar la firma API.

Después de configurar las siguientes propiedades de conexión, está listo para conectarse:

• User: establezca esto en el nombre de usuario de la API.
• Password: establezca esto en la contraseña de la API.
• Signature: Establézcalo en Firma.
• UseSandbox: establezca esto en verdadero si está utilizando credenciales de sandbox.

Conexión a la API REST

Crear una Aplicación

Para registrar una aplicación y obtener las credenciales del cliente de OAuth, el ID del cliente y el secreto del cliente:

1. Inicie sesión en su cuenta de desarrollador de PayPal y Mis aplicaciones y credenciales (en Panel).
2. Desplácese hasta la sección de aplicaciones REST API y haga clic en Create App.
3. Introduzca el nombre de la aplicación.
4. En la lista desplegable, seleccione la cuenta de espacio aislado que se utilizará para obtener datos.

PayPal genera un conjunto de sandbox y claves OAuth en vivo para la aplicación. Las credenciales de la zona de pruebas se muestran después de crear la aplicación. Para las credenciales en vivo, seleccione Live opción.

Las credenciales de sandbox se usarán para obtener datos solo para la cuenta de sandbox seleccionada al crear la aplicación, mientras que las credenciales de Live se usarán para obtener datos solo para la cuenta de desarrollador utilizada para crear esta aplicación.

Autenticar a PayPal

Después de configurar las siguientes propiedades de conexión, está listo para conectarse:

• InitiateOAuth: Establézcalo en GETANDREFRESH. Puedes usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken propiedad de conexión.
• OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
• OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
• UseSandbox: establezca esto en verdadero si está utilizando credenciales de sandbox.

Cuando se conecta, el conector completa el proceso de OAuth.

1. Intercambia el OAuthClientId y OAuthClientSecret Para el OAuthAccessToken.
2. Actualiza el token de acceso cuando caduca.
3. Guarda los valores de OAuth en OAuthSettingsLocation para persistir a través de las conexiones.

Características Avanzadas

Esta sección detalla una selección de funciones avanzadas del conector de PayPal.

Vistas definidas por el usuario

El conector le permite definir tablas virtuales, llamadas vistas definidas por el usuario, cuyo contenido se decide mediante una consultar preconfigurada. Estas vistas son útiles cuando no puede controlar directamente las consultas que se envían a los controladores. Consulte Vistas definidas por el usuario para obtener una descripción general de la creación y configuración de vistas personalizadas.

Configuración SSL

Usar Configuración SSL para ajustar cómo el conector maneja las negociaciones de certificados TLS/SSL. Puede elegir entre varios formatos de certificado; ver el SSLServerCert propiedad en "Opciones de cadena de conexión" para obtener más información.

Apoderado

Para configurar el conector mediante Configuración de proxy de Agente Privado, Selecciona el Use Proxy Settings casilla de verificación en la pantalla de configuración de la conexión.

Procesamiento de consultas

El conector descarga tanto del procesamiento de la declaración SELECT como sea posible a PayPal y luego procesa el resto de la consultar en la memoria (lado del cliente).

Consulte Procesamiento de consultas para más información.

Vistas Definidas por el Usuario

El conector Jitterbit para PayPal le permite definir una tabla virtual cuyos contenidos se deciden mediante una consultar preconfigurada. Estas se denominan Vistas definidas por el usuario, que son útiles en situaciones en las que no puede controlar directamente la consultar que se envía al controlador, por ejemplo, cuando se utiliza el controlador de Jitterbit. Las vistas definidas por el usuario se pueden utilizar para definir predicados que siempre se aplican. Si especifica predicados adicionales en la consultar a la vista, se combinan con la consultar ya definida como parte de la vista.

Hay dos formas de crear vistas definidas por el usuario:

• Cree un archivo de configuración con formato JSON que defina las vistas que desea.
• Declaraciones DDL.

Definición de Vistas Usando un Archivo de Configuración

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

• Cada elemento raíz define el nombre de una vista.
• Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

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

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

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

Definición de Vistas Usando Sentencias DDL

El conector también es capaz de crear y modificar el esquema a través de instrucciones DDL como CREATE LOCAL VIEW, ALTER LOCAL VIEW y DROP LOCAL VIEW.

Crear una Vista

Para crear una nueva vista usando declaraciones DDL, proporcione el nombre de la vista y la consultar de la siguiente manera:

CREATE LOCAL VIEW [MiNombre de Vista] AS SELECT * FROM Customers LIMIT 20;

Si no existe ningún archivo JSON, el código anterior crea uno. Luego, la vista se crea en el archivo de configuración JSON y ahora se puede detectar. La ubicación del archivo JSON se especifica mediante UserDefinedViews propiedad de conexión.

Modificar una Vista

Para modificar una vista existente, proporcione el nombre de una vista existente junto con la nueva consultar que le gustaría usar en su lugar:

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

Luego, la vista se actualiza en el archivo de configuración JSON.

Suelta una Vista

Para descartar una vista existente, proporcione el nombre de un esquema existente junto con la nueva consultar que le gustaría usar en su lugar.

DROP LOCAL VIEW [MyViewName]

Esto elimina la vista del archivo de configuración JSON. Ya no se puede consultar.

Esquema para Vistas Definidas por el Usuario

Las vistas definidas por el usuario se exponen en UserViews esquema por defecto. Esto se hace para evitar que el nombre de la vista entre en conflicto con una entidad real en el modelo de datos. Puede cambiar el nombre del esquema utilizado para UserViews configurando UserViewsSchemaName propiedad.

Trabajar con Vistas Definidas por el Usuario

Por ejemplo, una instrucción SQL con una vista definida por el usuario llamada UserViews.RCustomers solo enumera clientes en Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Un ejemplo de una consultar al controlador:

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

Dando como resultado la consultar efectiva a la fuente:

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

Ese es un ejemplo muy simple de una consultar a una vista definida por el usuario que es efectivamente una combinación de la consultar de vista y la definición de vista. Es posible componer estas consultas en patrones mucho más complejos. Todas las operaciones de SQL están permitidas en ambas consultas y se combinan cuando corresponde.

Configuración SSL

Personalización de la Configuración SSL

De forma predeterminada, el conector intenta negociar SSL/TLS comparando el certificado del servidor con el almacén de certificados de confianza del sistema.

Para especificar otro certificado, consulte SSLServerCert propiedad de los formatos disponibles para hacerlo.

Modelo de Datos

Jitterbit Connector for PayPal modela dos APIs de PayPal como bases de datos relacionales, la API REST y la API SOAP. Selecciona el Schema propiedad y utilice la información de cada sección para seleccionar la API adecuada en función de las necesidades de su proyecto.

Usando la API REST

La API REST es la API más nueva y se está volviendo más popular entre los usuarios de PayPal. Sin embargo, la API REST enumera solo las transacciones y acciones realizadas a través de la API REST y excluye la interfaz de usuario y la API SOAP.

Ver Modelo de datos REST para las entidades disponibles en la API REST.

Usando la API de SOAP

La API SOAP (clásica) tiene información completa sobre transacciones, que incluye transacciones creadas a partir de la interfaz de usuario, la API REST y la API SOAP.

Consulte Modelo de datos SOAP para las entidades disponibles en la API de SOAP.

Modelo de Datos REST

Jitterbit Connector for PayPal modela las APIs REST de PayPal como vistas de bases de datos y procedimientos almacenados. Estos se definen en archivos de esquema, que son archivos de configuración simples basados en texto que facilitan la personalización de los esquemas.

Esta sección proporciona las limitaciones y los requisitos de la API para el modelo de datos REST; puedes usar el SupportEnhancedSQL función, configurada de forma predeterminada, para eludir la mayoría de estas limitaciones.

Puntos de Vista

Puntos de vista son tablas que no se pueden modificar. Normalmente, los datos de solo lectura se muestran como vistas.

Procedimientos Almacenados

NOTE: Los procedimientos almacenados no se admiten actualmente. Consulte la nota anterior para detalles.

Procedimientos almacenados son interfaces similares a funciones para PayPal. Se pueden utilizar para acceder a otras funciones de PayPal que no aparecen en las Vistas.

Limitaciones de la API REST de PayPal

Existen algunas limitaciones en la API REST de PayPal. Por ejemplo, no proporciona ninguna forma de enumerar todos los pedidos/pagos, por lo que para consultar las vistas relacionadas como Artículos de pedido, Detalles del pedido, Pagos debe conocer el DNI respectivo y especificarlo.

Puntos de Vista

Las vistas se componen de columnas y pseudocolumnas. Las vistas son similares a las tablas en la forma en que se representan los datos; sin embargo, las vistas no admiten actualizaciones. Las entidades que se representan como vistas suelen ser entidades de solo lectura. A menudo, un procedimiento almacenado* está disponible para actualizar los datos si dicha funcionalidad es aplicable a la fuente de datos.

Las consultas se pueden ejecutar contra una vista como si fuera una tabla normal, y los datos que regresan son similares en ese sentido.

Se admiten las vistas dinámicas, como las consultas expuestas como vistas y las vistas para buscar combinaciones específicas de elementos de trabajo project_team.

Conector Jitterbit para Vistas de PayPal

Detalles de Autorización

Consulta detalles sobre Autorizaciones.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es Id, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor y recuperan detalles para una autorización específica.

SELECT * FROM AuthorizationDetails WHERE Id = '70K15739YA1955155'

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

Columnas

Saldos

Enumere todos los saldos no criptográficos.

Información Específica de la Tabla

Seleccionar

Esta vista devuelve una lista de disputas para el usuario autenticado.

Los siguientes filtros son compatibles con la API de PayPal:

• Divisa
• A partir del tiempo

Los filtros solo admiten el operador =.

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor.

• La siguiente consultar recupera los detalles de una moneda específica:

  SELECT * FROM Balances WHERE Currency = 'USD'
  

• La siguiente consultar devuelve detalles de los registros de Saldo creados antes de la fecha y hora especificadas:

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

Columnas

Capturar Detalles

Consulta detalles sobre un pago capturado.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es Id, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor y recuperan detalles para una captura específica.

SELECT * FROM CaptureDetails WHERE Id = '9G02572041588110H'

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

Columnas

Detalles de la Tarjeta de Crédito

Consulta detalles sobre el instrumento de financiación del pagador, como una tarjeta de crédito o un token que representa una tarjeta de crédito.

Información Específica de la Tabla

Seleccionar

Esta vista devuelve una lista de tarjetas de crédito o detalles de una específica.

Los siguientes filtros son compatibles con la API de PayPal:

• Identificación
• CreateTime
• Identificación del comerciante
• ID de tarjeta externa
• ID de cliente externo

El filtro CreateTime admite los operadores >, >=, <, <= y =, mientras que los otros filtros solo admiten el operador =.

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor.

• La siguiente consultar recupera los detalles de una tarjeta de crédito específica:

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

• La siguiente consultar devuelve detalles de los registros de tarjetas de crédito creados después de la fecha especificada:

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

Columnas

CryptoSaldos

Enumere todos los saldos criptográficos.

Información Específica de la Tabla

Seleccionar

Esta vista devuelve una lista de disputas para el usuario autenticado.

Los siguientes filtros son compatibles con la API de PayPal:

• A partir del tiempo

Los filtros solo admiten el operador =.

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor.

• La siguiente consultar devuelve detalles de los registros de Saldo creados antes de la fecha y hora especificadas:

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

Columnas

DisputaDetalles

Los comerciantes, socios y desarrolladores externos de PayPal pueden usar la API de disputas de PayPal para gestionar las disputas.

Información Específica de la Tabla

Seleccionar

Esta vista devuelve una lista de disputas con información detallada para el usuario autenticado.

Los siguientes filtros son compatibles con la API de PayPal:

• ID de disputa

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor.

• La siguiente consultar recupera los detalles de una Disputa específica:

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

Columnas

Disputas

Los comerciantes, socios y desarrolladores externos de PayPal pueden usar la API de disputas de PayPal para gestionar las disputas.

Información Específica de la Tabla

Seleccionar

Esta vista devuelve una lista de disputas para el usuario autenticado.

Los siguientes filtros son compatibles con la API de PayPal:

• ID de disputa
• Estado de disputa
• CreateTime

El filtro CreateTime admite los operadores >, >=, <, <= y =, mientras que los otros filtros solo admiten el operador =.

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor.

• La siguiente consultar recupera los detalles de una disputa específica:

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

• La siguiente consultar devuelve detalles de los registros de Disputa creados después de la fecha especificada:

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

Columnas

DisputaTransacciones

Los comerciantes, socios y desarrolladores externos de PayPal pueden usar la API de disputas de PayPal para gestionar las disputas.

Información Específica de la Tabla

Seleccionar

Esta vista devuelve una lista de transacciones con detalles para una disputa específica.

Los siguientes filtros son compatibles con la API de PayPal:

• ID de disputa

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor.

• La siguiente consultar recupera los detalles de la transacción para una disputa específica:

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

Columnas

Facturas

Consultar Facturas en PayPal.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es Id. El procesamiento del lado del servidor solo es compatible con el operador '='.

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

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Columnas

Notificaciones

Consulta la lista de tipos de eventos que están suscritos a un Webhook.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es WebhookId, que solo admite el operador =. Este es un parámetro obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, la siguiente consultar se procesa en el lado del servidor y recupera la lista de notificaciones para el webhook especificado.

SELECT * FROM Notifications WHERE WebhookId='8BU398853V564980H'

Columnas

Detalles del Pedido

Consulta de detalles sobre un Pedido.

Información Específica de la Tabla

Seleccionar

Nota: La API REST de PayPal no nos proporciona una forma de enumerar todos los OrderId-s, por lo que debe especificarlo. Si necesita tal caso de uso, se recomienda utilizar las Transacciones y Detalles de transacción vistas en el esquema SOAP.
El único filtro admitido por la API de PayPal es Id, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor y recuperan los detalles de un pedido específico.

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

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

Columnas

Encargar Artículos

Obtener los artículos en un Pedido.

Información Específica de la Tabla

Seleccionar

Nota: La API REST de PayPal no nos proporciona una forma de enumerar todos los OrderId-s, por lo que debe especificarlo. Si necesita tal caso de uso, se recomienda utilizar las Transacciones y Elementos de transacción vistas en el esquema SOAP.
El único filtro admitido por la API de PayPal es OrderId, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor y recuperan los detalles de un pedido específico.

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

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

Columnas

Pagos

Consulta detalles sobre Pagos autorizados.

Información Específica de la Tabla

Seleccionar

Los únicos filtros admitidos son ID y OrderId. Los filtros solo admiten el operador =. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, la siguiente consultar se procesa del lado del servidor y recupera los pagos que se crearon después de la fecha especificada.

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

Columnas

PagoTransacciones

Consulte los detalles de la transacción, incluido el monto y los detalles del artículo.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es PaymentId, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor y recuperan una lista de transacciones para el pago especificado.

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

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

Columnas

Detalles de Pago

Recuperar detalles sobre pagos.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es PayoutBatchId, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, la siguiente consultar se procesa del lado del servidor y recupera los detalles de un pago específico.

SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'

Columnas

Elementos de Pago

Recupera elementos de pago de un Pago.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es PayoutBatchId, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, la siguiente consultar se procesa del lado del servidor y recupera todos los elementos de pago para un Pago específico.

SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2'

Columnas

Planes

Enumere los planes de facturación.

Información Específica de la Tabla

Seleccionar

Esta vista devuelve una lista de planes de suscripción para el usuario autenticado.

Los siguientes filtros son compatibles con la API de PayPal:

• Identificación
• ID del Producto

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

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Columnas

ReembolsoDetalles

Consultar detalles sobre un Reembolso específico.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es Id, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor y recuperan detalles para un reembolso específico.

SELECT * FROM RefundDetails WHERE Id = '4W92068757818534U'

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

Columnas

VentaDetalles

Consulta de detalles sobre una Transacción de Venta.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es Id, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor y recuperan los detalles de una venta específica.

SELECT * FROM SaleDetails WHERE Id = '6M2430095X488331A'

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

Columnas

Suscripciones

Obtenga detalles de facturación y suscripción.

Información Específica de la Tabla

Seleccionar

El único filtro admitido por la API de PayPal es Id, que es obligatorio. El conector procesa otros filtros del lado del cliente dentro del conector.

SELECT * FROM Subscriptions WHERE Id='1234'

NOTE: Podemos obtener el SubscriptionId creando la suscripción usando el procedimiento CreateSubscription Stored.

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Columnas

Transacciones de Suscripción

Enumera las transacciones de una suscripción.

Información Específica de la Tabla

Seleccionar

Esta vista devuelve una lista de transacciones con detalles para una suscripción específica.

Los siguientes filtros son compatibles con la API de PayPal:

• ID de suscripción
• Hora de inicio
• Hora de finalización

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 y EndTime son los parámetros necesarios para esta vista y si StartTime y EndTime no se especifican en la consultar, los valores predeterminados se asignarán desde el código. 2. Podemos obtener el SubscriptionId creando la suscripción usando el procedimiento CreateSubscription Stored.

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Informes de Transacciones

Enumera los informes de transacciones.

Información Específica de la Tabla

Seleccionar

Los filtros admitidos por la API de PayPal son StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. El procesamiento del lado del servidor solo es compatible con el operador '='.

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

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

TransacciónInformesCarritoInfoArtículoDetalles

Muestra la información del carrito de los informes de transacciones.

Información Específica de la Tabla

Seleccionar

Los filtros admitidos por la API de PayPal son StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. El procesamiento del lado del servidor solo es compatible con el operador '='.

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

El conector procesa otros filtros del lado del cliente dentro del conector. Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

TransacciónInformesIncentivoDetalles

Lista de detalles de incentivos de los informes de transacciones.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Webhooks

Consulta la lista de Webhooks.

Información Específica de la Tabla

Seleccionar

La API de PayPal no admite ningún filtro en esta tabla. Sin embargo, las proyecciones son compatibles. Todos los filtros se procesan del lado del cliente dentro del conector.

Puede desactivar la ejecución de la consultar en el lado del cliente configurando SupportEnhancedSQL a falso.

Columnas

Procedimientos Almacenados

Procedimientos almacenados* son interfaces similares a funciones que amplían la funcionalidad del conector más allá de las simples operaciones SELECT con PayPal.

Procedimientos almacenados* aceptan una lista de parámetros, realizan la función prevista y luego devuelven, si corresponde, cualquier dato de respuesta relevante de PayPal, junto con una indicación de si el procedimiento tuvo éxito o no.

Conector Jitterbit para Procedimientos Almacenados de PayPal

CreatePayouts

Realiza pagos en PayPal.

Información Específica de la Tabla

Elementos de pago

No puede crear un pago sin elementos de pago. Para crear elementos de pago, debe insertar datos mediante un agregado JSON o mediante una tabla temporal denominada "PayoutItem#TEMP". Consulte los siguientes ejemplos para obtener más información.

Ejemplo: Cree pagos usando el agregado JSON

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" +
"]'

Ejemplo: crear pagos usando una tabla temporal

Primero debe insertar en PayoutItem#TEMP para crear elementos de pago.

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')

Ejecutar

Después de crear al menos un elemento de pago, puede ejecutar el procedimiento almacenado.

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

Las siguientes columnas son necesarias para crear un elemento de pago:

• Tipo de destinatario
• ImporteValor
• Monto de dinero
• SenderItemId
• Receptor

Aporte

Columnas del conjunto de resultados

Crear Suscripción

Cree una suscripción para PayPal.

Procedimiento Almacenado* Información Específica

CreateSubscription Procedimiento almacenado* requiere PlanId para crear una suscripción de 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" +
"  }'

Las siguientes columnas son necesarias para crear una suscripción:

• ID del plan

Aporte

Columnas del conjunto de resultados

Obtener token de acceso de OAuth

Obtiene el token de acceso OAuth de PayPal.

Columnas del conjunto de resultados

RefreshOAuthAccessToken

Actualiza el token de acceso de OAuth utilizado para la autenticación con varios servicios de PayPal.

Columnas del conjunto de resultados

Enviar factura

Enviar una Factura, por Id, a un cliente.

Entrada

Modelo de datos SOAP

Jitterbit Connector for PayPal modela las APIs SOAP de PayPal como base de datos Vistas. Normalmente, los datos de solo lectura se muestran como vistas. Estos se definen en archivos de esquema, que son archivos de configuración simples basados en texto que facilitan la personalización de los esquemas.

Esta sección proporciona las limitaciones y los requisitos de la API para el modelo de datos SOAP; puedes usar el SupportEnhancedSQL función, configurada de forma predeterminada, para eludir la mayoría de estas limitaciones.

Vistas

Puntos de vista son tablas que no se pueden modificar. Normalmente, los datos de solo lectura se muestran como vistas.

Vistas

Las vistas se componen de columnas y pseudocolumnas. Las vistas son similares a las tablas en la forma en que se representan los datos; sin embargo, las vistas no admiten actualizaciones. Las entidades que se representan como vistas suelen ser entidades de solo lectura. A menudo, un procedimiento almacenado* está disponible para actualizar los datos si dicha funcionalidad es aplicable a la fuente de datos.

Las consultas se pueden ejecutar contra una vista como si fuera una tabla normal, y los datos que regresan son similares en ese sentido.

Se admiten las vistas dinámicas, como las consultas expuestas como vistas y las vistas para buscar combinaciones específicas de elementos de trabajo project_team.

Conector de Jitterbit para vistas de PayPal

Saldo

Ver todas las divisas de la cuenta y sus saldos.

Columnas

BalanceAffecting

Consulta de Transacciones que afectan el saldo de la cuenta.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Transferencia de saldo

Consulta de Transacciones que involucran Transferencias de Saldo.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Pago de facturas

Transacciones de consulta que involucran transacciones de BillPay.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Conversiones de moneda

Consulta de Transacciones que involucran Conversiones de Divisas.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Dividendo

Consulta de Transacciones que involucran Dividendos.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

ECheck

Consultar transacciones que involucren cheques electrónicos.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Tarifa

Consulta de Transacciones con Comisiones.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Fondos agregados

Consulta de Transacciones generadas cuando se agregan fondos al saldo.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

FondosRetirados

Consulta de Transacciones generadas cuando se retiran fondos del saldo.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Pago masivo

Consulta de Transacciones de Pagos Masivos.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Solicitud de dinero

Consulta de transacciones de solicitud de dinero.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Recibido

Consulta de transacciones de pagos recibidos.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Referencia

Consultar Transacciones que involucren Referencias.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Reembolso

Consulta de Transacciones que involucran Devoluciones.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Reversión

Transacciones de consulta que involucran reversiones de BillPay.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Enviado

Consulta de Transacciones enviadas por pagos.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Envío

Consultar Transacciones que involucren Tarifas de Envío de UPS.

Columnas

Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Suscripción

Consulta de Transacciones de Suscripciones.

Columnas