Skip to main content

Documentación

Página de pago de suscripciones alojada

Una página segura para aceptar los pagos de sus suscripciones.

Las suscripciones son transacciones recurrentes basadas en ciclos de facturación predefinidos. Las suscripciones funcionan bien para las empresas que ofrecen un servicio que se puede renovar de forma regular.

La página de pago de suscripciones alojada le permite cobrar pagos periódicos por productos a través del plan de precio fijo. Esta solución alojada le permite gestionar de forma eficaz las suscripciones de su organización y cobrar los pagos de los clientes de forma más sencilla al dirigirlos a la página de pago de las suscripciones alojadas.

Los casos de uso comunes pueden incluir:

  • Aceptar pagos recurrentes de sus clientes sin tener que gestionar la información de sus tarjetas de crédito.

  • Ofrecer una solución de suscripciones a otras empresas o comercios sin un certificado PCI-DSS.

  • Una solución sin código para generar una página de suscripciones a través del Client Portal.

  1. Introduzca su información de pago.

  2. Introduzca su dirección y dirección de facturación.

  3. Haga clic en Suscribirse.

    648083a011d45.png
  4. Complete la verificación 3DS.

    648083a2efec3.png
  5. Redirigir a la página suscripción exitosa.

  6. Haga clic en Finalizar.

Métodos de pago compatibles

Son compatibles los siguientes métodos de pago para la página de pago de suscripciones alojada:

  • Tarjetas

  • Redireccionamiento bancario

Paso 1: Crear un producto para su suscripción
643e7dcc20aad.jpg
  1. Decida el producto que va a usar para su suscripción.

  2. Consulte Crear producto para generar el producto que se utilizará en la descripción. Consulte Suscripciones: crear un producto para obtener más información sobre los parámetros.

    Nota: Un producto utilizado en los planes de precios debe tener su type establecido para el servicio.

  3. Rapyd genera un ID de producto.

  4. Rapyd envía una respuesta de webhook.

Paso 2: Crear un plan para su suscripción
643e7dcdcb593.png
  1. Usted decide la configuración de precios para su plan de precios.

  2. Use Crear plan para generar su plan. Consulte Suscripciones: crear un plan para obtener más información sobre los parámetros.

  3. Rapyd genera un ID de plan.

  4. Rapyd envía una respuesta de webhook.

    Nota: La página de suscripción alojada solo se puede generar con el plan de precio fijo.

Paso 3: Crear un cliente para su suscripción.
643e7dcf9f8b3.png
  1. Use Crear cliente para generar un cliente a través de la API para su suscripción.

  2. Pídale a Rapyd que genere un ID de cliente. Consulte Suscripciones: crear un perfil de cliente para obtener más información sobre los parámetros.

  3. Rapyd genera un ID de cliente único.

    Nota: Consulte crear una suscripción por página alojada para obtener más información sobre cómo generar una página de pago de una suscripción alojada sin ID de cliente.

Paso 4: Generar una página de pago alojada para las suscripciones
643e7dd1aceb0.png
  1. Solicite a Rapyd que genere una página de pago de suscripción alojada.

  2. Rapyd procesa su solicitud y envía la respuesta con la URL de redireccionamiento.

  3. Muestre la URL de redireccionamiento al cliente.

  4. El cliente completa el pago en la página alojada.

Los siguientes diagramas de secuencia de mensajes describen cómo se intercambia la información entre Rapyd, el comercio, los clientes del comercio y la red de tarjetas.

Crear página de suscripción alojada

subscription-hosted-card-payment-with-automatic-capture.svg

Rapyd recopila la información de pago de la suscripción a través de una página alojada generada. Si un cliente no tiene una tarjeta registrada, puede dirigirlo a la página de pago de las suscripciones alojadas para recopilar la información de pago de la suscripción. Además, puede generar varias páginas alojadas y enviarlas a diferentes clientes.

Puede personalizar el aspecto de la página para que coincida con su marca y su experiencia en el sitio web, tal y como se describe en Personalización de la página alojada

Debe completar los siguientes pasos para generar una página de pago de suscripciones alojadas:

  1. Crear un producto (Integración de API)

  2. Crear un plan (Cree un plan de precios para el producto mediante la integración de la API)

  3. Crear un cliente (Integración de API o mediante el Client portal)

  4. Genere una página de pago alojada para las suscripciones (integración de API o mediante el Client portal)

La página Crear Suscripción Alojada describe los parámetros de la solicitud con mayor detalle.

Parámetro del cuerpo

Requerido

Descripción

Se relaciona con

subscription_items

Conjunto de artículos de suscripción. Cada artículo contiene un plan (obligatorio) y una cantidad (opcional).

  • La cantidad predeterminada es 1

  • La cantidad es relevante para la licencia usage_type

Objeto de suscripción

customer

ID del cliente que paga esta suscripción. Cadena que comienza por cus_

billing

Determine el método de facturación. Definido en pay_automatically

    • Solicitud

      • // Request URL: GET https://sandboxapi.rapyd.net/v1/checkout/subscription
                                                
        // Message body: 
        {
        
            "subscription_items": [
         
                {
                    "plan": "plan_9d7bc847f1ad3fe36f389273f5e22b56",
                    "quantity": 1
                }
         
            ],
         
            "country": "US",
            "language": "EN",
            "customer": "cus_49ea9673acfbe53fac114fbf4bd94be3",
            "coupon": "coupon_da009d56dd6b7fdf4de28af673430a63",
            "billing": "pay_automatically",
            "tax_percent": 3,
            "trial_period_days": 7,
         
                    "metadata": [{
         
                "my_meta_data_key": "metadata_value"
         
            }]
         
         }

Texto del botón principal

El parámetro merchant_main_button de la solicitud le permite definir el texto del botón principal de la página de suscripción alojada. Esto es para las suscripciones que no tienen versiones de prueba.

Las opciones para el texto del botón son:

  • Suscribirse

  • Adquirir

  • Pagar

Cuando se usa una suscripción con versión de prueba en la página de suscripción alojada, la opción predeterminada de Iniciar la versión de prueba se usa.

La página Crear suscripción Alojada describe los campos de la respuesta.

    • Respuesta

      • {
        
        "status": {
                                                     
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "9e7ede34-9c44-494f-b833-c1734afee646"
                                                     
        },
                                                     
        "data": {
                                                     
            "id": "hp_sub_f477f7b37e66ffef1b4be5becfccea46",
            "status": "NEW",
            "cancel_url": "https://www.rapyd.net",
            "complete_url": "https://www.rapyd.net",
            "language": "en",
            "merchant_color": "",
            "merchant_logo": "",
            "merchant_website": "https://www.rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "rap",
            "merchant_terms": "",
            "merchant_privacy_policy": "",
            "page_expiration": 1701594560,
            "redirect_url": "https://sandboxcheckout.rapyd.net/subscription?token=hp_sub_f477f7b37e66ffef1b4be5becfccea46",
            "merchant_main_button": "start_trial",
                                                     
            "subscription_items": [
                                                     
                {
                                                     
                    "id": "",
                    "plan": {
                                                     
                        "id": "09de6170-d76b-4450-8dcb-7833f5706384",
                        "tiers": [],
                        "token": "plan_9d7bc847f1ad3fe36f389273f5e22b56",
                        "amount": 100,
                        "product": null,
                        "interval": "day",
        
                        "metadata": {
                                                     
                            "merchant_defined": true
                                                     
                        },
                                                     
                        "nickname": "hcp",
                        "created_at": 1700384490,
                        "deleted_at": 0,
                        "tiers_mode": "",
                        "usage_type": "licensed",
                        "product_name": "HCP",
                        "product_type": "service",
                        "currency_code": "USD",
                        "product_token": "product_eb45c8152bede037911d5e99ee4bc116",
                        "billing_scheme": "per_unit",
                        "interval_count": 20,
                        "aggregate_usage": "sum",
                        "organization_id": "",
                        "transform_usage": {},
                        "product_is_active": 1,
                        "trial_period_days": 0,
                        "transform_usage_round": "up",
                        "transform_usage_divide_by": 1
                                                     
                    },
                                                     
                    "token": "",
                    "created": 0,
                    "deleted": false,
                    "prorate": true,
                    "quantity": 1,
                    "plan_token": "plan_9d7bc847f1ad3fe36f389273f5e22b56",
                    "clear_usage": false,
                    "proration_date": 0
                                                     
                }
                                                     
            ],
                                                     
            "customer": "cus_49ea9673acfbe53fac114fbf4bd94be3",
            "customer_payment_methods": [],
            "bank_redirect_customer_payment_methods": [],
            "country": "US",
            "trial_from_plan": false,
            "trial_period_days": 7,
            "tax_percent": 3,
            "billing_cycle_anchor": 0,
            "billing": "pay_automatically",
            "cancel_checkout_url": "https://www.rapyd.net",
            "complete_checkout_url": "https://www.rapyd.net",
                                                     
            "payment": {
                                                     
                "amount": null,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "",
                "country_code": "",
                "status": "",
                "description": "",
                "merchant_reference_id": "",
                "customer_token": "",
                "payment_method": "",
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": "",
                "complete_payment_url": "",
                "error_payment_url": "",
                "receipt_number": "",
                "flow_type": "",
                "address": null,
                "statement_descriptor": "",
                "transaction_id": "",
                "metadata": null,
                "failure_code": "",
                "failure_message": "",
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": "",
                "payment_method_type_category": "",
                "fx_rate": "",
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": "",
                "payment_fees": null,
                "invoice": "",
                "escrow": null,
                "group_payment": "",
                "cancel_reason": null,
                "initiation_type": "",
                "mid": "",
                "next_action": "not_applicable"
                                                     
            },
                                                     
            "metadata": [
                                                     
                {
                                                     
                    "my_meta_data_key": "metadata_value"
                                                     
                }
                                                     
            ],
                                                     
            "custom_elements": {
                    
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
                                                     
            },
                                                     
            "payment_method_type": "",
            "coupon": "coupon_da009d56dd6b7fdf4de28af673430a63",
                                         
        }
                                                     
        }

Los datos de esta sección muestran:

  • El ID de la suscripción es sub_f477f7b37e66ffef1b4be5becfccea46.

  • El método de pago del cliente se cobrará cada 20 días por las unidades que utilice para el servicio de suscripción.

  • El ID del cupón es coupon_da009d56dd6b7fdf4de28af673430a63.

Soporte de cupones para páginas de suscripción alojadas

Los cupones son compatibles para las páginas de suscripción alojadas. Introduzca el parámetro «cupón» en la solicitud de creación de una suscripción por página alojada con el ID del cupón, empezando por cupón_.

También puede añadir un cupón pasando el parámetro «cupón» en la solicitud de Crear Cliente. Luego, pase el ID de cliente al crear la página de suscripción alojada.