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.
Usa este flujo para procesar pagos ecommerce con tarjeta desde el API de autorización de PayIn.
Este flujo utiliza el mismo endpoint base de autorización. Revisa los ambientes y la configuración general en el Overview . Características del flujo
Tipo de flujo Síncrono o con autenticación adicional, según la configuración del comercio y del emisor.
Método de pago Permite procesar pagos ecommerce con tarjeta.
Validación final La confirmación del resultado debe realizarse desde backend.
PCI Si el flujo envía o recibe datos sensibles de tarjeta, debes contar con cumplimiento PCI.
Checkout Web (Flex) Si utilizas Checkout Web (Flex), en esta página también se documenta la estructura de respuesta que recibirás en responseCallback.
Consideraciones Este flujo puede operar en tres escenarios: autorización sin autenticación, autorización con autenticación 3DS Redirect y autorización con datos de autenticación 3DS obtenidos previamente.
No expongas datos sensibles de pago en frontend, logs o herramientas sin enmascaramiento. Si tu integración procesa directamente PAN, CVV o datos equivalentes, valida previamente la habilitación PCI de tu comercio.
Request Antes de consumir este endpoint, solicita tu Access Token en Autenticación . Campo Descripción Valor Tipo Obligatorio AuthorizationToken Bearer obtenido desde autenticación Bearer {access_token}String SI Content-TypeFormato del request application/jsonString SI ALG-API-VERSIONVersión del API 1709847567String SI
Authorization: Bearer {access_token} Content-Type: application/json ALG-API-VERSION: 1709847567
Body Objeto raíz del request Campo Descripción Ejemplo Tipo Obligatorio actionAcción a ejecutar authorizeString SI channelCanal de la operación ecommerceString SI merchant_codeCódigo del comercio your_merchant_codeString SI merchant_operation_numberIdentificador único de la operación en el comercio. Debe ser diferente en cada transacción. 2391645String SI payment_methodObjeto con la información del método de pago Object Object SI payment_detailsObjeto con el detalle del pago y datos del cliente Object Object SI
Objeto payment_method Campo Descripción Ejemplo Tipo Obligatorio method_nameNombre del método de pago CARDString SI method_detailsObjeto con la información específica de la tarjeta Object Object SI
Objeto payment_method.method_details Campo Descripción Ejemplo Tipo Obligatorio panNúmero de la tarjeta 4051420006041115String SI expiry_dateFecha de expiración en formato MMYY 1231String SI security_codeCódigo de seguridad de la tarjeta (CVV) 123String SI card_holderObjeto con información del titular de la tarjeta Object Object SI redirect_urlURL de retorno al finalizar la autenticación https://pay-me.comString NO callback_urlURL para notificación host to host https://pay-me.com/callbackString NO authentication_resultResultado de autenticación 3DS obtenida previamente Object Object NO installmentsObjeto con información de plan y cuotas Object Object NO
Objeto payment_method.method_details.card_holder Campo Descripción Ejemplo Tipo Obligatorio first_nameNombres del titular PedroString SI last_nameApellidos del titular MirandaString SI emailCorreo electrónico del titular pedro@pay-me.comString SI phoneObjeto con el teléfono del titular Object Object SI
Objeto payment_method.method_details.card_holder.phone Campo Descripción Ejemplo Tipo Obligatorio prefixCódigo de país del teléfono 51String SI numberNúmero del teléfono 999835685String SI
Objeto payment_method.method_details.authentication_result.3ds_secure Campo Descripción Ejemplo Tipo Obligatorio versionVersión del protocolo 3DS 2.1.0String NO electronic_commerce_indicatorValor del ECI 05String NO cardholder_authentication_verification_valueValor del CAVV AJkBB5NBeQAAAD3MYENQdAAAAAA=String NO ds_transaction_idDirectory Server Transaction ID ABC123String NO three_ds_server_transaction_id3DS Server Transaction ID ABC123String NO trans_statusResultado de autenticación YString NO
Objeto payment_method.method_details.installments Campo Descripción Ejemplo Tipo Obligatorio planPlan de cuotas a usar en la autorización 01String NO numberCantidad de cuotas 3String NO
Valores para installments.plan:
01: Normal02: Diferido (no disponible) Ejemplo 1: sin autenticación { "action" : "authorize" , "channel" : "ecommerce" , "merchant_code" : "your_merchant_code" , "merchant_operation_number" : "2391645" , "payment_method" : { "method_name" : "CARD" , "method_details" : { "pan" : "4051420006041115" , "expiry_date" : "1231" , "security_code" : "123" , "card_holder" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "prefix" : "51" , "number" : "999835685" } }, "installments" : { "plan" : "01" , "number" : "3" } } }, "payment_details" : { "amount" : "15000" , "currency" : "604" , "billing" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "country_code" : "+51" , "subscriber" : "999835685" }, "location" : { "line_1" : "Av. Casimiro Ulloa 333" , "line_2" : "Miraflores" , "city" : "Lima" , "state" : "Lima" , "country" : "Peru" } }, "shipping" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "country_code" : "+51" , "subscriber" : "999835685" }, "location" : { "line_1" : "Av. Casimiro Ulloa 333" , "line_2" : "Miraflores" , "city" : "Lima" , "state" : "Lima" , "country" : "Peru" } }, "customer" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "country_code" : "+51" , "subscriber" : "999835685" }, "location" : { "line_1" : "Av. Casimiro Ulloa 333" , "line_2" : "Miraflores" , "city" : "Lima" , "state" : "Lima" , "country" : "Peru" } }, "product_details" : [] } }
Ejemplo 2: con autenticación Redirect { "action" : "authorize" , "channel" : "ecommerce" , "merchant_code" : "your_merchant_code" , "merchant_operation_number" : "2391645" , "payment_method" : { "method_name" : "CARD" , "method_details" : { "pan" : "4051420006041115" , "expiry_date" : "1231" , "security_code" : "123" , "card_holder" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "prefix" : "51" , "number" : "999835685" } }, "redirect_url" : "https://pay-me.com" , "callback_url" : "https://pay-me.com/callback" , "installments" : { "plan" : "01" , "number" : "3" } } }, "payment_details" : { "amount" : "15000" , "currency" : "604" , "billing" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "country_code" : "+51" , "subscriber" : "999835685" }, "location" : { "line_1" : "Av. Casimiro Ulloa 333" , "line_2" : "Miraflores" , "city" : "Lima" , "state" : "Lima" , "country" : "Peru" } }, "shipping" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "country_code" : "+51" , "subscriber" : "999835685" }, "location" : { "line_1" : "Av. Casimiro Ulloa 333" , "line_2" : "Miraflores" , "city" : "Lima" , "state" : "Lima" , "country" : "Peru" } }, "customer" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "country_code" : "+51" , "subscriber" : "999835685" }, "location" : { "line_1" : "Av. Casimiro Ulloa 333" , "line_2" : "Miraflores" , "city" : "Lima" , "state" : "Lima" , "country" : "Peru" } }, "product_details" : [] } }
Ejemplo 3: con datos de autenticación 3DS previos { "action" : "authorize" , "channel" : "ecommerce" , "merchant_code" : "your_merchant_code" , "merchant_operation_number" : "2391645" , "payment_method" : { "method_name" : "CARD" , "method_details" : { "pan" : "4051420006041115" , "expiry_date" : "1231" , "security_code" : "123" , "card_holder" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "prefix" : "51" , "number" : "999835685" } }, "authentication_result" : { "3ds_secure" : { "version" : "2.1.0" , "electronic_commerce_indicator" : "05" , "cardholder_authentication_verification_value" : "AJkBB5NBeQAAAD3MYENQdAAAAAA=" , "ds_transaction_id" : "ABC123" , "three_ds_server_transaction_id" : "ABC123" , "trans_status" : "Y" } }, "installments" : { "plan" : "01" , "number" : "3" } } }, "payment_details" : { "amount" : "15000" , "currency" : "604" , "billing" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "country_code" : "+51" , "subscriber" : "999835685" }, "location" : { "line_1" : "Av. Casimiro Ulloa 333" , "line_2" : "Miraflores" , "city" : "Lima" , "state" : "Lima" , "country" : "Peru" } }, "shipping" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "country_code" : "+51" , "subscriber" : "999835685" }, "location" : { "line_1" : "Av. Casimiro Ulloa 333" , "line_2" : "Miraflores" , "city" : "Lima" , "state" : "Lima" , "country" : "Peru" } }, "customer" : { "first_name" : "Pedro" , "last_name" : "Miranda" , "email" : "pedro@pay-me.com" , "phone" : { "country_code" : "+51" , "subscriber" : "999835685" }, "location" : { "line_1" : "Av. Casimiro Ulloa 333" , "line_2" : "Miraflores" , "city" : "Lima" , "state" : "Lima" , "country" : "Peru" } }, "product_details" : [] } }
Response Objeto transaction Campo Descripción Ejemplo Tipo Obligatorio transaction_idIdentificador único de la transacción 5hk8rwa3h3cq9oyfs3a28v1msString SI channelCanal de la transacción ecommerceString SI stateEstado actual de la transacción AUTORIZADOString SI state_reasonMotivo o descripción del estado actual Approval and completed successfullyString SI amountMonto de la transacción 15000String SI currencyCódigo de moneda 604String SI payment_methodObjeto con información del método de pago Object Object SI continue_urlURL para continuar el proceso de autenticación https://api.dev.alignet.io/payment/continue/card/...String NO expiration_dateFecha de expiración de la transacción Object Object NO processor_responseResultado devuelto por la procesadora Object Object NO authentication_resultResultado de autenticación aplicado a la transacción Object Object NO risk_evaluationResultado de evaluación antifraude Object Object NO additional_fieldsDatos adicionales enviados en el request Object Object NO lifecycleHistorial de estados de la transacción Array Array SI
continue_url y expiration_date se muestran cuando la transacción queda en estado PENDIENTE.
No uses meta.status.code como validador de autorización o denegación del pago. Ese código solo indica si el servicio procesó o respondió correctamente; el resultado del pago se valida con transaction.state y, como respaldo, desde backend con consulta o notificación.
Objeto transaction.payment_method Campo Descripción Ejemplo Tipo Obligatorio method_nameMétodo de pago utilizado CARDString SI method_detailsObjeto con información detallada del método Object Object NO
Objeto transaction.payment_method.method_details Campo Descripción Ejemplo Tipo Obligatorio masked_panTarjeta enmascarada 411111********1111String NO brandMarca de la tarjeta VISAString NO binBIN de la tarjeta 411111String NO last_panÚltimos dígitos de la tarjeta 9268String NO card_typeTipo de tarjeta DEBITString NO card_countryPaís de la tarjeta PEString NO issuerBanco emisor BANCO DE CREDITO DEL PERU - BCPString NO installmentsInformación de plan y cuotas Object Object NO redirect_urlURL de retorno enviada en el request https://pay-me.comString NO callback_urlURL de callback enviada en el request https://pay-me.com/callbackString NO
Objeto transaction.payment_method.method_details.installments Campo Descripción Ejemplo Tipo Obligatorio planPlan aplicado a la transacción NORMALString NO installment_numberNúmero de cuotas 2String NO
Objeto transaction.expiration_date Campo Descripción Ejemplo Tipo Obligatorio utc_timeFecha de expiración en UTC 2024-03-12T22:49:36.018ZString NO unix_timeFecha de expiración en unix time 1710282940Integer NO
Objeto transaction.processor_response Campo Descripción Ejemplo Tipo Obligatorio authorization_codeCódigo de autorización 055552String NO brand_transaction_idID de la transacción ante la marca 100BString NO result_messageMensaje del resultado de autorización Object Object NO
Objeto transaction.processor_response.result_message Campo Descripción Ejemplo Tipo Obligatorio codeCódigo del resultado 00String NO descriptionDescripción del resultado Approval and completed successfullyString NO
Objeto transaction.authentication_result Campo Descripción Ejemplo Tipo Obligatorio versionVersión del protocolo de autenticación 2.1.0String NO eciElectronic Commerce Indicator 05String NO ds_transaction_idDS Transaction ID ABC123String NO 3ds_transaction_id3DS Server Transaction ID ABC123String NO trans_statusEstado del resultado de autenticación AString NO
Objeto transaction.lifecycle Campo Descripción Ejemplo Tipo Obligatorio stateEstado registrado en el historial AUTORIZADOString SI dateFecha del cambio de estado Object Object SI
Objeto transaction.lifecycle[].date Campo Descripción Ejemplo Tipo Obligatorio utc_timeFecha en UTC 2024-03-12T22:49:36.018ZString SI unix_timeFecha en unix time 1710282940Integer SI
Ejemplo 1: sin autenticación { "success" : "true" , "action" : "authorize" , "merchant_code" : "your_merchant_code" , "merchant_operation_number" : "2391645" , "transaction" : { "transaction_id" : "5hk8rwa3h3cq9oyfs3a28v1ms" , "channel" : "ecommerce" , "state" : "AUTORIZADO" , "state_reason" : "Approval and completed successfully" , "amount" : "15000" , "currency" : "604" , "payment_method" : { "method_name" : "CARD" , "method_details" : { "masked_pan" : "411111********1111" , "brand" : "VISA" , "bin" : "411111" , "last_pan" : "9268" , "card_type" : "DEBIT" , "card_country" : "PE" , "issuer" : "BANCO DE CREDITO DEL PERU - BCP" , "installments" : { "plan" : "NORMAL" , "installment_number" : "2" } } }, "processor_response" : { "authorization_code" : "055552" , "brand_transaction_id" : "100B" , "result_message" : { "code" : "00" , "description" : "Approval and completed successfully" } }, "additional_fields" : null , "lifecycle" : [ { "state" : "REGISTRADO" , "date" : { "utc_time" : "2024-03-12T22:49:36.018Z" , "unix_time" : 1710282940 } }, { "state" : "PENDIENTE" , "date" : { "utc_time" : "2024-03-12T22:49:36.018Z" , "unix_time" : 1710282940 } }, { "state" : "AUTORIZADO" , "date" : { "utc_time" : "2024-03-12T22:49:36.018Z" , "unix_time" : 1710282940 } } ] }, "meta" : { "status" : { "code" : "00" , "message_ilgn" : [ { "locale" : "es_PE" , "value" : "Procesado correctamente" } ] } } }
Ejemplo 2: con autenticación Redirect { "success" : "true" , "action" : "authorize" , "merchant_code" : "your_merchant_code" , "merchant_operation_number" : "2391645" , "transaction" : { "transaction_id" : "5hk8rwa3h3cq9oyfs3a28v1ms" , "channel" : "ecommerce" , "state" : "PENDIENTE" , "state_reason" : "Url generada para continuar con la Autenticacion" , "continue_url" : "https://api.dev.alignet.io/payment/continue/card/81vrxn30vja1gwcfsdng4i5g5" , "amount" : "15000" , "currency" : "604" , "payment_method" : { "method_name" : "CARD" , "method_details" : { "masked_pan" : "411111********1111" , "brand" : "VISA" , "bin" : "411111" , "last_pan" : "9268" , "card_type" : "DEBIT" , "card_country" : "PE" , "issuer" : "BANCO DE CREDITO DEL PERU - BCP" , "installments" : { "plan" : "NORMAL" , "installment_number" : "2" }, "redirect_url" : "https://pay-me.com" , "callback_url" : "https://pay-me.com/callback" } }, "processor_response" : { "authorization_code" : "055552" , "brand_transaction_id" : "100B" , "result_message" : { "code" : "00" , "description" : "Approval and completed successfully" } }, "additional_fields" : null , "lifecycle" : [ { "state" : "REGISTRADO" , "date" : { "utc_time" : "2024-03-12T22:49:36.018Z" , "unix_time" : 1710282940 } }, { "state" : "PENDIENTE" , "date" : { "utc_time" : "2024-03-12T22:49:36.018Z" , "unix_time" : 1710282940 } } ] }, "meta" : { "status" : { "code" : "00" , "message_ilgn" : [ { "locale" : "es_PE" , "value" : "Procesado correctamente" } ] } } }
Ejemplo 3: con datos de autenticación 3DS previos { "success" : "true" , "action" : "authorize" , "merchant_code" : "your_merchant_code" , "merchant_operation_number" : "2391645" , "transaction" : { "transaction_id" : "5hk8rwa3h3cq9oyfs3a28v1ms" , "channel" : "ecommerce" , "state" : "AUTORIZADO" , "state_reason" : "Approval and completed successfully" , "amount" : "15000" , "currency" : "604" , "payment_method" : { "method_name" : "CARD" , "method_details" : { "masked_pan" : "411111********1111" , "brand" : "VISA" , "bin" : "411111" , "last_pan" : "9268" , "card_type" : "DEBIT" , "card_country" : "PE" , "issuer" : "BANCO DE CREDITO DEL PERU - BCP" , "installments" : { "plan" : "NORMAL" , "installment_number" : "2" } } }, "processor_response" : { "authorization_code" : "055552" , "brand_transaction_id" : "100B" , "result_message" : { "code" : "00" , "description" : "Approval and completed successfully" } }, "additional_fields" : null , "authentication_result" : { "version" : "2.1.0" , "eci" : "05" , "ds_transaction_id" : "" , "3ds_transaction_id" : "" , "trans_status" : "A" }, "lifecycle" : [ { "state" : "REGISTRADO" , "date" : { "utc_time" : "2024-03-12T22:49:36.018Z" , "unix_time" : 1710282940 } }, { "state" : "PENDIENTE" , "date" : { "utc_time" : "2024-03-12T22:49:36.018Z" , "unix_time" : 1710282940 } }, { "state" : "AUTORIZADO" , "date" : { "utc_time" : "2024-03-12T22:49:36.018Z" , "unix_time" : 1710282940 } } ] }, "meta" : { "status" : { "code" : "00" , "message_ilgn" : [ { "locale" : "es_PE" , "value" : "Procesado correctamente" } ] } } }
Buenas prácticas
Valida siempre el resultado desde backend.
Usa autenticación 3DS cuando aplique a tu modelo de riesgo o configuración.
No expongas PAN, CVV ni datos sensibles en frontend o logs.
Enmascara siempre la información sensible en observabilidad y soporte.
Revisa el estado final de la operación antes de tomar acciones de negocio.
Errores comunes
Datos sensibles expuestos No envíes ni almacenes PAN, CVV o datos sensibles en frontend, logs o herramientas sin protección.
Validación incompleta No tomes decisiones de negocio confiando únicamente en validaciones del lado cliente o en estados no confirmados.
Siguiente paso
API de Consulta Revisa cómo consultar el estado de una operación.
