Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pay-me.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Inicializar componente Débito Automático

Cuando se crea una nueva instancia del componente es necesario un objeto de configuración con las propiedades nonce, payload y settings.

​
Parámetros

CampoTipoObligatorioDescripción
actionStringSIAcción a ejecutar. Valores: subscribe / update_subscription
merchant_affiliation_codeStringSICódigo de afiliación generado por el comercio.
merchant_codeStringSICódigo del comercio que inicia la afiliación.
typeStringSITipo de afiliación. Solo se permite MANUAL.
frequencyStringNOFrecuencia de los cobros de la afiliación.
amountStringNOMonto de los cobros en centavos.
maxAmountStringNOMonto máximo para los pagos recurrentes en centavos.
currencyString (ISO 4217)SIMoneda de los cobros. Ej.: 604 = PEN.
CampoTipoObligatorioDescripción
beneficiary.first_nameStringSINombres del beneficiario.
beneficiary.last_nameStringSIApellidos del beneficiario.
beneficiary.emailStringSICorreo electrónico del beneficiario.
beneficiary.phone.country_codeStringSICódigo de país del teléfono. Ej.: 51.
beneficiary.phone.subscriberStringSINúmero de teléfono del beneficiario.
beneficiary.identity_document.typeStringNOTipo de documento de identidad. Ej.: DNI.
beneficiary.identity_document.identifierStringNONúmero del documento de identidad.
beneficiary.identity_document.countryString (ISO-3166)NOPaís de emisión del documento. Ej.: PE.
beneficiary.location.line_1StringSIDirección principal.
beneficiary.location.line_2StringNODirección complementaria.
beneficiary.location.cityStringSICiudad de residencia.
beneficiary.location.stateStringSIDepartamento o región.
beneficiary.location.countryString (ISO-3166)SICódigo ISO del país. Ej.: PE.
CampoTipoObligatorioDescripción
additional_fields.FACTURACION_IDStringNOID del cliente o contrato para facturación.
additional_fields.PLANStringNONombre o código del plan al que se afilia el beneficiario.
wallet.user_idStringNOID del usuario en el wallet para asociar una tarjeta a la afiliación.

​
Flujos disponibles

authorize

Muestra un formulario de pago con los diferentes métodos habilitados para el comercio.

subscribe

Muestra el formulario de afiliación para registrar un nuevo débito automático.

update_subscription

Muestra un formulario para actualizar una afiliación existente.

​
Mostrar Pay-me Flex Débito Automático

Este es el paso final. Se indica dentro de qué elemento del DOM se debe mostrar el formulario y las funciones callback para ejecutarse durante el proceso.

​
Callbacks

responseCallback

Se ejecuta cuando el proceso está completado (Autorizado/Denegado).

trackingCallback

Se ejecuta por cada evento disparado durante el proceso.

onErrorCallback

Se ejecuta cuando hay un error durante el proceso.

​
Casos de uso

    {
        "action": "authorize",
        "channel": "ecommerce",
        "merchant_code": "your_merchant_code",
        "merchant_operation_number": "976867",
        "payment_details": {
            "amount": "387000",
            "currency": "604",
            "billing": {
                "first_name": "Mateo",
                "last_name": "Zayas Meza",
                "email": "Mateo_ZayasMeza85@yahoo.com",
                "phone": { "country_code": "51", "subscriber": "945831902" },
                "location": {
                    "line_1": "Poblado Concepción 7",
                    "line_2": "Puerta 249",
                    "city": "LIMA",
                    "state": "LIMA",
                    "country": "PE"
                }
            },
            "wallet": { "user_id": "72661927" }
        }
    }

​
Response de afiliación

CampoTipoObligatorioDescripción
successBooleanSIIndica si el proceso se realizó correctamente.
affiliation.affiliation_idString (UUID)SIID de la afiliación generado por el sistema.
affiliation.merchant_affiliation_codeStringSICódigo de afiliación generado por el comercio.
affiliation.merchant_codeString (UUID)SICódigo del comercio.
affiliation.stateStringSIEstado de la afiliación. Ej.: ACTIVE.
affiliation.typeStringSITipo de afiliación. Ej.: MANUAL.
affiliation.frequencyStringNOFrecuencia de los cobros.
affiliation.amountStringNOMonto de la afiliación en centavos.
affiliation.max_amountStringNOMonto máximo permitido.
affiliation.currencyString (ISO 4217)SIMoneda de los cobros.
CampoTipoObligatorioDescripción
affiliation.beneficiary.first_nameStringSINombres del beneficiario.
affiliation.beneficiary.last_nameStringSIApellidos del beneficiario.
affiliation.beneficiary.emailStringSICorreo electrónico.
affiliation.beneficiary.phone.country_codeStringSICódigo del país del teléfono.
affiliation.beneficiary.phone.subscriberStringSINúmero de teléfono.
affiliation.beneficiary.identity_document.typeStringNOTipo de documento.
affiliation.beneficiary.identity_document.identifierStringNONúmero de documento.
affiliation.beneficiary.identity_document.countryStringNOPaís del documento.
affiliation.beneficiary.location.line_1StringSIDirección principal.
affiliation.beneficiary.location.cityStringSICiudad.
affiliation.beneficiary.location.stateStringSIDepartamento o región.
affiliation.beneficiary.location.countryStringSIPaís.
CampoTipoObligatorioDescripción
affiliation.card.tokenStringSIToken de la tarjeta afiliada.
affiliation.card.brandStringSIMarca de la tarjeta. Ej.: VISA, MSCD.
affiliation.card.binStringSIBIN de la tarjeta.
affiliation.card.last_panStringSIÚltimos 4 dígitos de la tarjeta.
affiliation.card.issuer_nameStringNONombre del emisor de la tarjeta.
affiliation.card.card_holder_nameStringSINombre del titular de la tarjeta.
meta.status.codeStringSICódigo de resultado del procesamiento.
meta.status.message_ilgn[].localeStringSIIdioma del mensaje de respuesta.
meta.status.message_ilgn[].valueStringSIDescripción del resultado.