Skip to main content
Skip table of contents

API de Autorización con Yape

Request

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

Field

Description

Accepted Value

Type

Obligatorio

callback_url

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

Cadena alfanumérica

String

NO

phone

Objeto que contiene información del titular de Yape

Objeto

SI

phone.country_code

Código del pais del teléfono

Cadena alfanumérica

String

SI

phone.subscriber

Numero del teléfono

Cadena numérica

String

SI

otp

Código OTP de la Billetera Yape

Cadena numérica

String

SI

Ejemplo

JSON
{
    "action": "authorize",
    "channel": "ecommerce",
    "merchant_code":"b0deb6f3-e51a-48a7-9268-f1441d46f7bd",
    "merchant_operation_number": "5974484",
    "payment_method": {
        "method_name": "YAPE",
        "method_details": {
            "callback_url": "https://pay-me.com/callback",
            "phone": {
                "country_code": "+51",
                "subscriber": "969929157"
            },
            "otp": "557454"
        }
    },
    "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 YAPE 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

  • AUTORIZADO

  • DENEGADO

  • INVALIDO

String

SI

transaction.state_reason

Observacion del estado

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

  • YAPE

String

SI

transaction.payment_method.method_detail

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

 

Object

SI

transaction.payment_method.method_detail.phone

Objeto que contiene información del telefono del cliente Yape

Object

SI

transaction.payment_method.method_detail.phone.country_code

Código del Pais del teléfono de Yape

Cadena numérica

String

SI

transaction.payment_method.method_detail.phone.subscriber

Número de telefono de Yape

Cadena numérica

String

SI

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.processor_response

Visible en estado AUTORIZADO - 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.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

  • AUTORIZADO

  • DENEGADO

  • INVALIDO

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

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": "Pago exitoso con Yape"
        "amount": "15000",
        "currency": "604",
        "payment_method": {
            "method_name": "YAPE",
            "method_details": {
                "phone": {
                    "country_code": "+51",
                    "subscriber": "969929157"
                },
                "masked_pan": "411111********1111",
                "brand": "VISA",
                "bin": "411111",
                "last_pan": "9268",
                "card_type": "DEBIT",
                "card_country": "PE",
                "issuer": "BANCO DE CREDITO DEL PERU - BCP",
            }
        },
        "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"
                }
            ]
        }
    }
}
JavaScript errors detected

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

If this problem persists, please contact our support.