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 |
|---|---|---|---|
| Token de identificación para uso del API creado previamente en API de Seguridad | Cadena alfanumérica |
|
Body
Se detalla el request que se usará para todos los métodos de pagos:
Field | Description | Accepted Value | Type | Obligatorio |
|---|---|---|---|---|
| Acción a ejecutar |
|
| SI |
| Canal donde se ejecutara la transacción |
|
| SI |
| Identificador del comercio | Cadena Alfanumérica |
| SI |
| Número de pedido de la operación | Cadena numérica mayor o igual de 6 dígitos |
| SI |
| Objeto relacionado al método de pago que se usará para la autorización. Este objeto varia por método de pago |
|
| SI |
| Nombre del método de pago que se usará para la autorización. |
|
| SI |
| Objeto que contiene información necesaria para procesar la autorización. Este objeto es necesario y cambia según el método de pago:
|
|
| NO* |
| Objeto con información de la transacción |
|
| SI |
| 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 |
| SI |
| Código ISO-3 de la moneda de la operación(Falta el link al ISO) | Cadena numérica |
| SI |
| Diccionario para enviar campos y valores personalizados como Ej.: external_id:21871054 |
|
| NO |
| Objeto con información del cliente que realiza la compra |
|
| NO |
| Nombres | Cadena alfanumérica |
| NO |
| Apellidos | Cadena alfanumérica |
| NO |
| Correo electrónico | Cadena alfanumérica |
| NO |
| Objeto con información del teléfono |
|
| NO |
| Código del pais del teléfono | Cadena numérica |
| NO |
| Número del teléfono | Cadena numérica |
| NO |
| Objeto con información de la persona |
|
| NO |
| Dirección 1 | Cadena alfanumérica |
| NO |
| Dirección 2 | Cadena alfanumérica |
| NO |
| Ciudad | Cadena alfanumérica |
| NO |
| Estado | Cadena alfanumérica |
| NO |
| Pais | Cadena alfanumérica Código del País en 2 letras ISO-3166 |
| NO |
| Objeto con información de facturación |
|
| SI |
| Nombres | Cadena alfanumérica |
| SI |
| Apellidos | Cadena alfanumérica |
| SI |
| Correo electrónico | Cadena alfanumérica |
| SI |
| Objeto con información del teléfono |
|
| SI |
| Código del pais del teléfono | Cadena numérica |
| SI |
| Numero del teléfono | Cadena numérica |
| SI |
| Objeto con información de la persona |
|
| SI |
| Dirección 1 | Cadena alfanumérica |
| SI |
| Dirección 2 | Cadena alfanumérica |
| NO |
| Ciudad | Cadena alfanumérica |
| SI |
| Estado | Cadena alfanumérica |
| SI |
| Pais | Cadena alfanumérica |
| SI |
| Objeto con información de envío |
| NO | |
| Nombres | Cadena alfanumérica |
| NO |
| Apellidos | Cadena alfanumérica |
| NO |
| Correo electrónico | Cadena alfanumérica |
| NO |
| Objeto con información del teléfono |
|
| NO |
| Código del pais del teléfono | Cadena numérica |
| NO |
| Numero del teléfono | Cadena numérica |
| NO |
| Objeto con información de la persona |
|
| NO |
| Dirección 1 | Cadena alfanumérica |
| NO |
| Dirección 2 | Cadena alfanumérica |
| NO |
| Ciudad | Cadena alfanumérica |
| NO |
| Estado | Cadena alfanumérica |
| NO |
| Pais | Cadena alfanumérica Código del País en 2 letras ISO-3166 |
| NO |
RESPONSE
Field | Description | Accepted Value | Type | Obligatorio |
|---|---|---|---|---|
| Indica si el proceso se realizó correctamente | Cadena alfanumérica |
| SI |
| Acción ejecutada. Los valores que puede tomar son:
| Cadena alfanumérica |
| SI |
| Canal donde se ejecutara la transacción |
|
| SI |
| Identificador del comercio | Cadena Alfanumérica |
| SI |
| Número de pedido de la operación | Cadena numérica mayor o igual de 6 dígitos |
| SI |
| Objeto con información de la transacción. Este objeto cambia según el método de pago:
|
| SI | |
| Identificador unico de la transacción | Cadena numérica |
| SI |
| Canal por la cual se realizó la transacción |
| ||
| Estado de la transacción |
|
| SI |
| Observacion del estado |
| SI | |
| Monto de la transacción | Cadena numérica |
| SI |
| Código de la moneda de la transacción | Cadena numérica |
| SI |
| Objeto que contiene información sobre el método de pago usado en la transacción |
| SI | |
| Nombre del método de pago que se usará para la autorización. |
|
| SI |
| Objeto que contiene información detallada relacionada al método. Este objeto varia por método.
|
|
| NO* |
|
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 |
| NO |
|
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:
|
|
| NO |
| Fecha en UTC |
|
| NO |
| Fecha en unix time |
|
| NO |
| 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.
| | NO | |
| Objeto que contiene los datos adicionales de la transacción enviados en el request. |
|
| NO |
| Array que contiene listado de los estado por la cual pasó la transacción |
|
| SI |
| Estado de la transacción → Estados |
|
| SI |
| Objeto que contiene la fecha en la que se realizó el cambio de estado |
|
| SI |
| Fecha en UTC | Cadena alfanumérica |
| SI |
| Fecha en unix time | Cadena alfanumérica |
| SI |
| Objeto que contiene metadados del flujo ejecutado | | SI | |
| Objeto que contiene el resultado del flujo ejecutado | | SI | |
| Código que representa el resultado del flujo ejecutado | Cadena numérica | | SI |
| Objeto que contiene el mensaje resultante del flujo | | SI | |
| Localidad a nivel de lenguaje para el mensaje del flujo ejecutado | Cadena alfanumérica | | SI |
| Mensaje resultante del flujo ejecutado | Cadena alfanumérica | | SI |
