Unlimited Plugins, WordPress themes, videos & courses! Unlimited asset downloads! From $16.50/m
Advertisement
  1. Code
  2. PayPal
Code

Integración PayPal Parte 2: PayPal REST API

by
Length:LongLanguages:
This post is part of a series called PayPal Integration.
PayPal Integration Part 1: PayPal Payment Buttons
PayPal Integration Part 3: PayPal Webhooks

Spanish (Español) translation by Rodney Martinez (you can also view the original English article)

Final product image
What You'll Be Creating

En este tutorial, voy a mostrarle cómo puede tomar pagos usando la PayPal REST API y C#. Todas las bibliotecas que tienen para diferentes lenguajes de programación como Ruby, Node.js, Python, PHP son muy similares, así que todos los conceptos aquí aplica para todas las bibliotecas.

Configuración del Proyecto

Para iniciar, he creado un proyecto MVC en Visual Studio 2015: File > New > Project, y seleccione ASP.NET Application.

Setting up a Project

Seleccione la plantilla ASP.NET 5 Web Application, la cual usa la nueva MVC 6. Es parecido a MVC 5 si es que usted ya está familiarizado con ella.

ASPNET MVC5

Como puede ver en la foto debajo, he añadido algunos archivos y carpetas para la solución. Las dos cosas más importantes son:

  1. En References, he eliminado el objeto DNX Core 5.0, que es el que nos permitiría ejecutar este proyecto en Mac OS X o Linux, pero la biblioteca de PayPal que necesitamos aún no ha sido actualizada.
  2. He añadido la carpeta "Services", en donde voy a envolver la lógica para las llamadas PayPal, así que podemos conservar los controladores bien y al mínimo.
Solution Explorer

Instale PayPal SDK usando NuGet. Clic-derecho sobre el nombre de la solución y seleccione Manage NuGet Packages, y luego busque "PayPal" para instalarlo.

Package Manager

Crear una PayPal App

Para integrar nuestra aplicación con PayPal, necesitamos navegar a PayPal Developers, y luego debajo de REST API apps, hacer clic en Create App.

PayPal Developer App Dashboard

Asigne un nombre a su aplicación y escoja una cuenta Sandbox Deleloper que esté asociada con la app. Para propósitos de prueba, luego podemos navegar a http://sandbox.paypal.com e iniciar sesión con los detalles de registro Sandbox para probar la cuenta PayPal y las transacciones.

PayPal Developer App

Después de hacer clic en Create App, veremos una pantalla de confirmación con el Client ID y Secret tokens.

PayPal App Credentials

Copie el clientId y and clientSecret tokens al archivo appsettings.json a como puede ver en la siguiente captura de pantalla:

Application Settings JSON

Probando los Pagos

PayPal ofrece una opción de prueba para pagos; Sandbox environment for testing. Puede crear compradores de prueba y cuentas de vendedores desde aquí. Cuando usted se registre, tendrá una cuenta Business en el Sandbox que está unido a su cuenta developer.

Para probar una nueva cuenta de prueba, inicie sesión en Developer site, y luego haga clic en la pestaña Dashboard y diríjase hacia Sandbox > Accounts. Aquí puede ver la lista de las cuentas de prueba si es que tiene alguna:

PayPal Sandbox

Si todavía no ha creado sus cuentas de prueba, entonces continúe y haga clic en Create Account, en la parte superior a la derecha, para crear al menos una cuenta personal de prueba y una cuenta de prueba business.

PayPal Test Account

Después de crear las cuentas de pruebas, puede iniciar sesión a través de www.sandbox.paypal.com con el correo electrónico y la clave de prueba que usted asigno a cada cuenta en el formulario anterior. Esto es muy útil para probar que cuando usted está comprando algo con la 'cuenta de prueba personal' los fondos están siendo transferidos a su 'cuenta de prueba business'. Ahora está listo para comenzar a integrar con PayPal y probar que los fondos son trasladados desde una cuenta hacia otra.

Único Pago PayPal

PayPal ofrece diferentes métodos de pago. Usted puede usar pagos directos de tarjetas de crédito, lo que significa que sus clientes no conseguirán ver la página de acceso PayPal o un resumen —ya que todo ocurre en su sitio web. Usted necesita ser un PCI obediente para esto y, le recomiendo usar Stripe, ya que sólo necesita SSL para usar su biblioteca JavaScript. Por otro lado, para tomar pagos por medio de PayPal payments, esto toma tres pasos:

  1. Especificar una información de pago para crear un pago; create a payment.
  2. Get payment approval, conseguir la aprobación del pago, para redireccionar a su cliente a PayPal para aprobar la transacción.
  3. Execute the payment, ejecutar el pago para capturar los fondos después PayPal redirecciona a su cliente de vuelta a su sitio.

En mi proyecto MVC, en la carpeta Services, he creado la clase PayPalPaymentService donde he agregado estos métodos:

Hay algunos parámetros que están siendo añadidos en esta llamada:

  • Intent: Con tres valores posibles: 'sale' para pagos inmediatos, 'authorize' para autorizar un pago para tomarlo después o 'order' para crear una orden. Cuando consigue la authorization para una pago para capturarlo después, usted tiene 3 días garantizado, aunque usted puede intentar capturar el pago hasta 29 días después.
  • Payer: La fuente de los fondos para este pago y los métodos de pago que están siendo usados —PayPal Wallet payment, Bank Direct Debit or Direct Credit card.
  • Transactions: Esto es utilizado para especificar la cantidad de pago y, de manera opcional, especificar los objetos por los cuales el cliente está pagando. Además, puede especificar el subtotal, el envío y los impuesto si es necesario.
  • Redirect URLs: Especificar la URL para la cual PayPal redireccionará sus clientes después de la transacción, para que usted pueda actualizar su base de datos y mostrar un mensaje de confirmación.

Las funciones anteriores pueden ser utilizadas desde su controladores como éste:

Como usted puede ver, he creado tres acciones:

  • CreatePayment: Esta es la acción que activa el pago. Está haciendo una llamada a PayPal para crear el pago Payment, luego está redireccionando al usuario a PayPal para aprobar la transacción.
  • PaymentSuccessful: Esta es la acción donde PayPal redirecciona de vuelta a nuestro cliente después de una pago exitoso. En este punto podemos ejecutar el pago para conseguir que los fondos sean transferidos a nuestra cuenta merchant.
  • PaymentCancelled: Esta acción es donde el usuario es redireccionado desde PayPal si el usuario cancela el proceso de aprobación. En este momento, probablemente usted querrá dar la opción al cliente para tratar de nuevo o para contactarse con usted.

Autorice un Pago para Capturarlo Después

Este escenario es muy parecido al caso anterior. Tal vez querrá usar este método si está tratando de tomar pedidos reservados para un producto que aún no está disponible. Los pasos para conseguir este pago son:

  1. Authorize the payment: autorizar el pago, el parámetro 'indent' para esta llamada debería ser 'authorize'.
  2. Capture the payment: o capturar el pago, tenga en cuenta que las autorizaciones están garantizadas para más de 3 días, aunque usted puede intentar capturar un pago hasta más de 29 días.

Para implementar este tipo de pagos, solamente he agregado un método nuevo a la clase PayPalPaymentService para capturar el pago:

Luego, desde el HomeController, he agregado dos acciones nuevas para mostrar este tipo de pago:

  • AuthorizePayment es la acción que activa el pago. Es parecida a la función anterior 'CreatePayment', pero estamos pasando 'authorize' como el parámetro 'intent' en este caso.
  • AuthorizeSuccessful es la acción donde su cliente será redireccionado después de haber aprobado con éxito el pago en PayPal. En este punto estoy capturando el pago, pero usted podría guardar el pago en su base de datos y capturar el pago cuando usted lo necesite.

En estos códigos de muestra, por simpleza, he codificado los valores de las variables de pago. En su aplicación real, probablemente usted las envolverá en métodos que tomaran todos estos valores como variables para que todo pueda ser ajustado de forma dinámica y reutilizarlo.

Suscripciones

A esto se le llama "Billing Plans" en PayPal,  Usando la PayPal REST API, usted puede crear, actualizar o eliminar planes de facturación, esto es algo que usted podría usar si usted quiere construir un panel de control para controlar estas cosas para su negocio.

Los pasos para crear cargos periódicos a sus clientes serían:

  1. Create a billing plan, crear un plan de facturación y; activate it, activarlo. Después de crear un Billing Plan, éste está en una condición CREATED. Necesita ser activado para hacer una consulta PATH.
  2. Create a billing agreement, crear un acuerdo de facturación y; execute it, ejecutarlo: La respuesta a la llamada para Create un acuerdo de facturación incluye los enlaces approval_url y execute_url. Necesitamos conseguir la aprobación para el acuerdo de facturación y luego ejecutar el acuerdo de facturación.

Planes de Facturación

Crear un Plan de Facturación

Crear un plan de facturación que defina los periodos de facturación. Esto es un resumen de los parámetros que necesitamos pasar para crear un plan.

  • Name: Nombre del plan de facturación.
  • Description: Una descripción del plan de facturación.
  • Type: Los valores permitidos son 'FIXED'; para un número fijo de pagos periódicos, o 'INFINITE' para un plan que se repite hasta que es cancelado manualmente.
  • Merchant Preferences: Este es un objeto que específica las preferencias tales como la configuración de la tarifa, máximos intentos fallados de un pago, devolver una URL, cancelar una URL, notificar URL, donde PayPal redireccionará al usuario después de un pago.
  • Payment Definitions: Un objeto Array de las definiciones de pago para este plan. Normalmente, este array tendría uno o dos definiciones de pagos. Si queremos ofrecer una versión gratuita o una prueba a un precio de descuento, entonces configuramos dos definiciones de pagos. El primero será la definición para el período de prueba, y la segunda definición sería para un pago regular. Las propiedades para una definición de pago Payment Definition son name, type (prueba o regular), frequency (día, semana, mes, año), frequency interval (si ajustamos la frequency a 'WEEK', es decir, semana, y la frequency interval a '1', entonces estamos definiendo un pago semanal), amount, la cantidad que se va a cargar a un cliente y cycles, que es el número total de pagos. Charge Models, es para especificar el costo de envío y el impuesto adicional para el valor de la cantidad para el plan.

Este es un fragmento de código que muestra como crear un Billing Plan:

Un plan de facturación recién creado está en una condición CREATED. Actívelo para la condición ACTIVE, para que sus clientes puedan suscribirse al plan. Para activar el plan, necesitamos hacer un PATCH request:

Como puede ver, las bibliotecas PayPal son una envoltura directa sobre su REST API, lo cual es bueno, pero la API también es muy compleja comparada a otras como Stripe. Por esta razón, es una muy buena opción envolver por completo la comunicación PayPal en objetos con APIs claras y sencillas par nuestras aplicaciones. Aquí puede ver lo que esto código envolvió en múltiples funciones tomando parámetros como:

Actualizando el Plan de Facturación

Usted puede actualizar la información para un plan de facturación que ya existe por medio de una solicitud 'PATCH'. Esta es una función que envuelve esa llamada:

Para actualizar la descripción del Billing Plan, plan de facturación, entonces podemos llamar esta función y pasar los parámetros correctos:

Borrar un Plan de Facturación

Lo ideal, cuando no quiera aceptar clientes nuevos a un plan de facturación 'Billing Plan', es que querrá actualizarlo a la condición 'INACTIVE'. Esto no afectará a los acuerdos de facturación que ya existen en este plan: Esto se puede hacer simplemente haciendo una llamada a la función UpdateBillingPlan:

Acuerdos de Facturación

Creando un Acuerdo de Facturación

Una vez que ha creado uno o más planes de facturación, querrá empezar que los clientes se inscriban a sus planes de suscripción. Para hacer esto, necesita coleccionar los detalles de sus clientes y hacer una solicitud a PayPal. Para probar esta funcionalidad, he agregado varias acciones al HomeController:

  • Subscribe: Esta es la primera acción que es llamada. Esto crea una prueba de un plan de facturación 'Billing Plan' y luego una acuerdo de facturación 'Billing Agreement' (suscripción) para que ese plan sea creado y el usuario sea redireccionado hacia PayPal para confirmar el pago.
  • SubscribeSuccess: Esta acción es uno usado como 'Return URL' después de una suscripción exitosa. El token identificador del acuerdo es pasado en la cadena de consulta, y usamos este token para ejecutar el acuerdo de facturación y activarlo.
  • SubscribeCancel: Esta acción es una que usamos para 'Cancel URL'. Si por alguna razón el pago falla, o su cliente cancela el pago en PayPal, entonces el usuario es llevado a esta acción y usted necesita controlar esto. Tal vez ofrecer la opción de probar otra vez.

Como puede ver en el fragmento de código anterior, he envuelto la mayor parte de la funcionalidad en varios métodos. El primero método es "CreateBillingPlan", que ya explicamos como funciona en la sección anterior. El segundo método es "CreateBillingAgreement" que es usado para suscribir un usuario a un plan:

El tercer método es "ExecuteBillingAgreement". Después de una suscripción exitosa aprobada, usamos el token devuelto para activar la suscripción.

Suspender un Acuerdo de Facturación

Use este método para suspender un acuerdo:

Reactivar un Acuerdo de Facturación

Este método es muy parecido al anterior:

Cancelar un Acuerdo de Facturación

Use esta función para cancelar un plan:

Actualice un Acuerdo de Facturación

Esta opción es muy limitada y lo que esperaría desde esta llamada es la posibilidad de cambiar el plan de suscripción, para actualizaciones o bajar la categoría de un cliente. Esto no tiene respaldo en una llamada única como ocurre en Stripe. Necesita manejar este escenario para cancelar el acuerdo actual y crear uno nuevo para actualizaciones o para cambio de categoría. No es lo ideal, pero podría cambiar en el futuro.

Conclusión

Esto es un resumen de las funciones más comunes que las personas pueden usar para integrar con PayPal. Su API es mucho mayor que los métodos de integración que se han explicado en este artículo, además, usted puede emitir reembolsos y reembolsos parciales, y éstos tienen muchas opciones diferentes para muchos casos en las muestras que hemos abordado en este artículo. Si está más interesado en conseguir más detalles acerca de cualquier integración específica, por favor, deje una sugerencia en los comentarios.

Advertisement
Advertisement
Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.