Skip to main content
Skip table of contents

API de Autorización con Tarjeta

Request

Objeto method_details para tarjetas que se encuentra dentro de la trama de autorización: API de Autorizacion.

Field

Description

Accepted Value

Type

Obligatorio

pan

Número de la tarjeta

Cadena numérica

String

SI

expiry_date

Fecha expiración de la tarjeta en el formato MMYY

Cadena numérica

String

SI

security_code

Código de seguridad de la tarjeta (CVV)

Cadena numérica

String

SI

card_holder

Objeto que contiene información del titular de la tarjeta

Object

SI

card_holder.first_name

Nombres del titular de la tarjeta

Cadena alfanumérica

String

SI

card_holder.last_name

Apellidos del titular de la tarjeta

Cadena alfanumérica

String

SI

card_holder.email

Correo electrónico el titular de la tarjeta

Cadena alfanumérica

String

SI

card_holder.phone

Objeto con información del teléfono del titular de la tarjeta

Object

SI

card_holder.phone.prefix

Código del pais del teléfono

Cadena numérica

String

SI

card_holder.phone.number

Numero del teléfono

Cadena numérica

String

SI

redirect_url

URL donde se realizará el redirect cuando finalice la autorización

*Aplica para Comercios con Autenticacion 3DS para tarjeta en una sola API.

Cadena alfanumérica

String

NO

callback_url

URL donde se realizará la notificacion host to host (server to server)

*Aplica para Comercios con Autenticacion 3DS para tarjeta en una sola API cuando es variable.

Cadena alfanumérica

String

NO

authentication_result.3ds_secure

Solo disponible para el comercio que consume previamente el servicio de Autenticacion 3DS directamente.

Objeto con información del resultado de autenticación 3DSecure

Object

NO

authentication_result.3ds_secure.version

Versión del protocolo

Cadena alfanumérica

String

NO

authentication_result.3ds_secure.electronic_commerce_indicator

Valor del ECI

Cadena alfanumérica

String

NO

authentication_result.3ds_secure.cardholder_authentication_verification_value

Valor del CAVV

Cadena alfanumérica

String

NO

authentication_result.3ds_secure.ds_transaction_id

Valor del directory server transaction id

Cadena alfanumérica

String

NO

authentication_result.3ds_secure.tds_transaction_id

Valor del 3DS server transaction id

Cadena alfanumérica

String

NO

authentication_result.3ds_secure.verifika_commerce_indicator

Valor del VCI

Cadena alfanumérica

String

NO

service.installments

Objeto con información de planes y cuotas

Object

NO

service.installments.plan

Plan ID que se usará para la autorización

  • 01 - NORMAL (disponible)

  • 02 - DIFERIDO (no disponible)

Cadena numérica

String

NO

service.installments.number

Cantidad de cuotas que se usará para la autorización

Cadena numérica

String

NO

Ejemplo 1 (sin Autenticación)

Request para autorizar Tarjeta sin Autenticacion.

JSON
{
    "action": "authorize",
    "channel": "ecommerce",
    "merchant_code":"b0deb6f3-e51a-48a7-9268-f1441d46f7bd",
    "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": "03"
            }
        }
    },
    "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)

Request para autorizar Tarjeta con Redirect para un API único de Autorización + Autenticación 3DS.

Para recibir la respuesta de la Autorizacion final con Autenticacion Redirect tomar en cuenta las Consideraciones para los métodos con Redirect.

JSON
{
    "action": "authorize",
    "channel": "ecommerce",
    "merchant_code":"b0deb6f3-e51a-48a7-9268-f1441d46f7bd",
    "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": "03"
            }
        }
    },
    "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)

Request para autorizar Tarjeta con datos resultado de Autenticacion 3DS, consumido anteriormente por otro API 3DS.

JSON
{
    "action": "authorize",
    "channel": "ecommerce",
    "merchant_code":"b0deb6f3-e51a-48a7-9268-f1441d46f7bd",
    "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": {
                "3d_secure": {
                    "version": "2.1.0",
                    "electronic_commerce_indicator": "05",
                    "cardholder_authentication_verification_value": "AJkBB5NBeQAAAD3MYENQdAAAAAA=",
                    "ds_transaction_id": "ABC123",
                    "three_ds_server_transaction_id": "ABC123",
                    "verifika_commerce_indicator": "TSY"
                }
            },
            "installments": {
                "plan": "01",
                "number": "03"
            }
        }
    },
    "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 para pagos con tarjetas que se encuentra dentro de la trama de respuesta.: API de Autorizacion.

Field

Description

Accepted Value

Type

Obligatorio

transaction.transaction_id

Identificador unico de la transacción

Cadena alfanumérica

String

SI

transaction.channel

Canal por la cual se realizó la transacción

  • ecommerce

String

SI

transaction.state

Estado actual de la transacción

  • PENDIENTE

  • AUTORIZADO

  • INVALIDO

  • DENEGADO

String

SI

transaction.state_reason

 

 

 

SI

transaction.amount

Monto de la transacción

Cadena numérica

String

SI

transaction.currency

Código de la moneda de la operación

Cadena numérica

String

SI

transaction.payment_method

Objeto que contiene información sobre el método de pago usado en la transacción

 

Object

SI

transaction.payment_method.method_name

Nombre del método de pago usado en la transacción

  • CARD

String

SI

transaction.payment_method.method_detail

Objeto que contiene información detallada relacionada al método. Este objeto varia por método.

 

Object

NO

transaction.payment_method.method_detail.masked_pan

Tarjeta enmascarada usada en la transacción

Cadela alfanumérica

String

NO

transaction.payment_method.method_detail.brand

Marca de la tarjeta usada en la transacción

Cadena alfabética

String

NO

transaction.payment_method.method_detail.bin

Bin de la tarjeta usada en la transacción

Cadena numérica

String

NO

transaction.payment_method.method_detail.last_pan

Ultimos 4 dígitos de la tarjeta usada en la transacción

Cadena numérica

String

NO

transaction.payment_method.method_detail.card_type

Tipo de tarjeta

Cadela alfanumérica

String

NO

transaction.payment_method.method_detail.card_country

Pais de la tarjeta

Cadela alfanumérica

String

NO

transaction.payment_method.method_detail.issuer

Banco emisor de la tarjeta

Cadela alfanumérica

String

NO

transaction.payment_method.method_detail.installments

Objeto que contiene información de los planes y cuotas usada en la transacción

 

Object

NO

transaction.payment_method.method_detail.installments.plan

Plan

  • NORMAL

  • DIFERIDO

String

NO

transaction.payment_method.method_detail.installments.installment_number

Número de cuotas

Cadena numérica

String

NO

transaction.payment_method.method_details.redirect_url

Visible en estado PENDIENTE

URL del redirect enviado en el Request

Cadena alfanumérica

String

NO

transaction.payment_method.method_details.callback_url

URL del callback enviado en el Request

Cadena alfanumérica

String

NO

transaction.continue_url

Visible en estado PENDIENTE

URL para continuar el proceso de pago. En el caso del método CARD, se redireccionará a la autenticación.

Cadena alfanumérica

String

NO

transaction.expiration_date

Visible en estado PENDIENTE

Objeto que contiene la fecha en la que se expirará la transacción.

 

Object

NO

transaction.expiration_date.utc_time

Fecha en UTC

 

String

NO

transaction.expiration_date.unix_time

Fecha en unix time

 

Integer

NO

transaction.processor_response

Visible en estado AUTORIADO - DENEGADO - EXTORNADO

Objeto que contiene el resultado de la autorización. Los valores son devueltos por la procesadora.

 

Object

NO

transaction.processor_response.authorization_code

Código de autorización

Cadena alfanumérica

String

NO

transaction.processor_response.brand_transaction_id

ID de la transacción ante la marca

Cadena alfanumérica

String

NO

transaction.processor_response.result_message

Objeto que contiene mensaje del resultado de la autorizacion

 

Object

NO

transaction.processor_response.result_message.code

Código del resultado de la autorización

Cadena alfanumérica

String

NO

transaction.processor_response.result_message.description

Descripción del resultado de la autorización

Cadena alfanumérica

String

NO

transaction.authentication_result

Objeto que contiene le resultado de la autenticación usada en al transacción

 

Object

NO

transaction.authentication_result.version

Version del protocolo de autenticación

Cadena alfanumérica

String

NO

transaction.authentication_result.eci

ECI

Cadena alfanumérica

String

NO

transaction.authentication_result.vci

VCI

Cadena alfanumérica

String

NO

transaction.authentication_result.ds_transaction_id

DS Transaction ID

Cadena alfanumérica

String

NO

transaction.authentication_result.3ds_transaction_id

3DServer Transaction ID

Cadena alfanumérica

String

NO

transaction.risk_evaluation

Objeto que contiene el resultado de la evaluación de antifraude.

Object

NO

transaction.additional_fields

Objeto que contiene los datos adicionales de la transacción enviados en el request

 

Object

NO

transaction.lifecycle

Array que contiene listado de los estado por la cual pasó la transacción

 

Array

SI

transaction.lifecycle.[].state

Estado de la transacción

  • REGISTRADO

  • PENDIENTE

  • AUTORIZADO

  • DENEGADO

String

SI

transaction.lifecycle.[].date

Objeto que contiene la fecha en la que se realizó el cambio de estado

 

Object

SI

transaction.lifecycle.[].date.utc_time

Fecha en UTC

Cadena alfanumérica

String

SI

transaction.lifecycle.[].date.unix_time

Fecha en unix time

Cadena alfanumérica

Integer

SI

Ejemplo 1 (sin Autenticación)

Response para autorizar Tarjeta sin Autenticacion.

JSON
{
    "success": "true",
    "action": "authorize",
    "merchant_code": "b0deb6f3-e51a-48a7-9268-f1441d46f7bd",
    "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": "02"
                }
            }
        },
        "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)

Response para autorizar Tarjeta con Redirect para un API único de Autorización + Autenticación 3DS.

Para recibir la respuesta de la Autorizacion final con Autenticacion Redirect tomar en cuenta las Consideraciones para los métodos con Redirect.

JSON
{
    "success": "true",
    "action": "authorize",
    "merchant_code": "b0deb6f3-e51a-48a7-9268-f1441d46f7bd",
    "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": "02"
                },
                "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)

Response para autorizar Tarjeta con datos resultado de Autenticacion 3DS, consumido anteriormente por otro API 3DS.

JSON
{
    "success": "true",
    "action": "authorize",
    "merchant_code": "b0deb6f3-e51a-48a7-9268-f1441d46f7bd",
    "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": "02"
                }
            }
        },
        "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",
            "vci": "TSYF",
            "ds_transaction_id": "",
            "3ds_transaction_id": ""
        },
        "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"
                }
            ]
        }
    }
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.