Skip to main content
Skip table of contents

API de Autorización - ecommerce

El API de Autorización permite generar una transacción dependiendo el método de pago que escoga.

REQUEST

Path

Method: POST

URL: {{base}}/charges

Headers

Para todos los métodos de pagos, se enviará los siguientes parámetros en la cabecera de la petición:

Field

Description

Accepted Value

Type

Authorization

Token de identificación para uso del API creado previamente en API de Seguridad

Cadena alfanumérica

String

Body

Se detalla el request que se usará para todos los métodos de pagos:

Field

Description

Accepted Value

Type

Obligatorio

action

Acción a ejecutar

  • authorize

String

SI

channel

Canal donde se ejecutara la transacción

  • ecommerce

String

SI

merchant_code

Identificador del comercio

Cadena Alfanumérica

String

SI

merchant_operation_number

Número de pedido de la operación

Cadena numérica mayor o igual de 6 dígitos

String

SI

payment_method

Objeto relacionado al método de pago que se usará para la autorización. Este objeto varia por método de pago

 

Object

SI

payment_method.method_name

Nombre del método de pago que se usará para la autorización.

  • CARD

  • BANK_TRANSFER

  • CUOTEALO

  • QR

  • YAPE

  • PAGOEFECTIVO

String

SI

payment_method.method_details

Objeto que contiene información necesaria para procesar la autorización. Este objeto es necesario y cambia según el método de pago:

 

Object

NO*

payment_details

Objeto con información de la transacción

 

Object

SI

payment_details.amount

Monto en centavos de la operación. La separación de decimales se aplicará según la moneda.

Ej.: Para S/. 10.50, se debe enviar “1050” y en currency “604” para Soles. (Falta el link al ISO)

Cadena numérica

String

SI

payment_details.currency

Código ISO-3 de la moneda de la operación(Falta el link al ISO)

Cadena numérica

String

SI

payment_details.additional_fields

Diccionario para enviar campos y valores personalizados como key:value

Ej.: external_id:21871054

key:value

Dictionary

NO

payment_details.customer

Objeto con información del cliente que realiza la compra

 

 

NO

payment_details.customer.first_name

Nombres

Cadena alfanumérica

String

NO

payment_details.customer.last_name

Apellidos

Cadena alfanumérica

String

NO

payment_details.customer.email

Correo electrónico

Cadena alfanumérica

String

NO

payment_details.customer.phone

Objeto con información del teléfono

 

Object

NO 

payment_details.customer.phone.country_code

Código del pais del teléfono

Cadena numérica

String

NO 

payment_details.customer.phone.subscriber

Número del teléfono

Cadena numérica

String

NO 

payment_details.customer.location

Objeto con información de la persona

 

Object

NO 

payment_details.customer.location.line_1

Dirección 1

Cadena alfanumérica

String

NO 

payment_details.customer.location.line_2

Dirección 2

Cadena alfanumérica

String

NO 

payment_details.customer.location.city

Ciudad

Cadena alfanumérica

String

NO 

payment_details.customer.location.state

Estado

Cadena alfanumérica

String

NO 

payment_details.customer.location.country

Pais

Cadena alfanumérica

Código del País en 2 letras ISO-3166

String

NO 

payment_details.billing

Objeto con información de facturación

 

Object

SI 

payment_details.billing.first_name

Nombres

Cadena alfanumérica

String

SI

payment_details.billing.last_name

Apellidos

Cadena alfanumérica

String

SI 

payment_details.billing.email

Correo electrónico

Cadena alfanumérica

String

SI 

payment_details.billing.phone

Objeto con información del teléfono

 

Object

SI 

payment_details.billing.phone.country_code

Código del pais del teléfono

Cadena numérica

String

SI 

payment_details.billing.phone.subscriber

Numero del teléfono

Cadena numérica

String

SI 

payment_details.billing.location

Objeto con información de la persona

 

Object

SI 

payment_details.billing.location.line_1

Dirección 1

Cadena alfanumérica

String

SI 

payment_details.billing.location.line_2

Dirección 2

Cadena alfanumérica

String

NO 

payment_details.billing.location.city

Ciudad

Cadena alfanumérica

String

SI 

payment_details.billing.location.state

Estado

Cadena alfanumérica

String

SI 

payment_details.billing.location.country

Pais

Cadena alfanumérica
Código del País en 2 letras ISO-3166

String

SI 

payment_details.shipping

Objeto con información de envío

Object

NO 

payment_details.shipping.first_name

Nombres

Cadena alfanumérica

String

NO 

payment_details.shipping.last_name

Apellidos

Cadena alfanumérica

String

NO 

payment_details.shipping.email

Correo electrónico

Cadena alfanumérica

String

NO 

payment_details.shipping.phone

Objeto con información del teléfono

 

Object

NO 

payment_details.shipping.phone.country_code

Código del pais del teléfono

Cadena numérica

String

NO 

payment_details.shipping.phone.subscriber

Numero del teléfono

Cadena numérica

String

NO 

payment_details.shipping.location

Objeto con información de la persona

 

Object

NO 

payment_details.shipping.location.line_1

Dirección 1

Cadena alfanumérica

String

NO 

payment_details.shipping.location.line_2

Dirección 2

Cadena alfanumérica

String

NO 

payment_details.shipping.location.city

Ciudad

Cadena alfanumérica

String

NO 

payment_details.shipping.location.state

Estado

Cadena alfanumérica

String

NO 

payment_details.shipping.location.country

Pais

Cadena alfanumérica

Código del País en 2 letras ISO-3166

String

NO 

RESPONSE

Field

Description

Accepted Value

Type

Obligatorio

success

Indica si el proceso se realizó correctamente

Cadena alfanumérica

String

SI

action

Acción ejecutada. Los valores que puede tomar son:

  • authorize

Cadena alfanumérica

String

SI

channel

Canal donde se ejecutara la transacción

  • ecommerce

String

SI

merchant_code

Identificador del comercio

Cadena Alfanumérica

String

SI

merchant_operation_number

Número de pedido de la operación

Cadena numérica mayor o igual de 6 dígitos

String

SI

transaction

Objeto con información de la transacción.

Este objeto cambia según el método de pago:

Object

SI

transaction.transaction_id

Identificador unico de la transacción

Cadena numérica

String

SI

transaction.channel

Canal por la cual se realizó la transacción

  • ecommerce

transaction.state

Estado de la transacción

  • PENDIENTE

  • AUTORIZADO

  • DENEGADO

  • INVALIDO

String

SI

transaction.state_reason

Observacion del estado

String

SI

transaction.amount

Monto de la transacción

Cadena numérica

Object

SI

transaction.currency

Código de la moneda de la transacció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 que se usará para la autorización.

  • CARD

  • BANK_TRANSFER

  • CUOTEALO

  • QR

  • YAPE

  • PAGOEFECTIVO

String

SI

transaction.payment_method.method_details

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

 

Object

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. Este objeto solo esta disponible para los siguientes métodos de pagos:

  • CARD (Cuando es por Redirect)

  • BANK_TRANSFER

  • PAGOEFECTIVO

  • QR

  • CUOTEALO

 

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

Objeto que contiene resultado detallado del procesamiento. Este objeto puede cambiar según el método de pago.

Visible en estado AUTORIZADO, DENEGADO, EXTORNADO

Este campo es variable y modificable en el tiempo, tomarlo como referencial.

 Object

NO

transaction.additional_fields

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

key:value

Dictionary

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 → Estados

  • REGISTRADO

  • PENDIENTE

  • AUTORIZADO

  • EXTORNADO

  • CANCELADO

  • EXPIRADO

  • LIQUIDADO

  • ABONADO

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

meta

Objeto que contiene metadados del flujo ejecutado

 Object

SI

meta.status

Objeto que contiene el resultado del flujo ejecutado

 Object

SI

meta.status.code

Código que representa el resultado del flujo ejecutado

Cadena numérica

 String

SI

meta.status.message_ilgn

Objeto que contiene el mensaje resultante del flujo

 Object

SI

meta.status.message_ilgn.[].locale

Localidad a nivel de lenguaje para el mensaje del flujo ejecutado

Cadena alfanumérica

 String

SI

meta.status.message_ilgn.[].value

Mensaje resultante del flujo ejecutado

Cadena alfanumérica

 String

SI

JavaScript errors detected

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

If this problem persists, please contact our support.