Archivos batch

Te presentamos una nueva forma de hacer operaciones con tarjeta; en esta guía te explicamos la estructura de los archivos para realizar cargos con token, devoluciones y creación de suscripciones.

Para poder utilizar estas operaciones es necesario contar con el token de la tarjeta, el cual lo puedes crear usando la guía de Cargos con token (Puntos 1 al 4), si requieres utilizar los datos de la tarjeta más de una vez se deberás almacenar el id del token para enviarlo en cargos posteriores para hacer esto consulta la guía de OneClick.

Nota: Para poder utlizar archivos deberás contactar con nuestra área de soporte para realizar las configuraciones necesarias en tu cuenta y activar esta caracteristica.

Cargos con Archivos

1. El comercio genera el Archivo de Cargos con los tokens generados en Openpay.
2. El comercio envía el Archivo de Cargos el cual será procesado por Openpay.
3. Openpay descarga el archivo de Cargos generado por el comercio.
4. Openpay notifica al comercio vía Webhook que se ha iniciado el procesamiento del archivo de cargos.
5. Openpay genera un Archivo de respuesta para el comercio, el cual contendrá el resultado de cada uno de los cargos realizados.
6. Openpay notifica al comercio vía Webhook de que se ha finalizado el procesamiento del archivo de cargos.

Archivos de envío

Tanto el archivo de creación de Token como el de realizar cargo deben cumplir con las siguientes características:

Nombrado de archivo

El nombre de archivo deberá ser [TIPO DE ARCHIVO] + [ID COMERCIO] + [FECHA] + [NUMERO DE ARCHIVO].txt

1. TIPO DE ARCHIVO: CG para el archivo de creación de cargos y RF para el archivo de reembolsos.
2. ID COMERCIO: Identificador del comercio de 20 caracteres en Openpay.
3. FECHA: Fecha de generación del archivo en formato (YYYYMMDD).
4. NUMERO DE ARCHIVO: Un número consecutivo del archivo por día.

Ejemplo de un nombre de archivo de tokens CGmzdtln0bmtms6o3kck8f2017062701.txt

Estructura de Archivos

Todo archivo ya sea de token o de creación de cargos deberá tener uno o varios registros de detalle (DTL) y un registro de sumarizado (TRL) que servirá para verificar el total de lineas contenidas en el archivo.
El separador de los campos será el carácter de pipe “|”.
La codificación del archivo deberá ser UTF-8.
El fin de linea que se espera es tipo unix "\n".

Archivos de respuesta

Por cada archivo enviado a Openpay, se deberá responder un archivo con las siguientes características:

Nombrado de archivo

El nombre de archivo deberá ser el mismo que el archivo de entrada más la cadena fija RSP que indica que es un archivo de respuesta.

Ejemplo de un nombre de archivo de respuesta CGmzdtln0bmtms6o3kck8f2017062701RSP.txt

En caso de que el archivo tenga error de estructura, el archivo de respuesta contendrá un solo registro de detalle (DTL) con el código de error 9999 error en la estructura del archivo, y con el detalle del error en la columna descripción.

Cuando el archivo sea procesado correctamente deberá contener un registro por cada registro existente en el archivo de entrada, se recomienda que para relacionar los registros del archivo de entrada con el de salida se utilice la del dato de la columna order_id, el archivo de respuesta al igual que el archivo de entrada contendrá un registro de sumarizado.

Registro de Sumarizado (TRL)

Cargos con token

Realizar cargos a tokens (DTL)

Archivo de petición de cargo

DTL|01|O-00016|kbsdfvndvptoy3q9yc1i|20.00|MXN|Cobro de servicio|Victor|Flores|vflores@hotmail.com|
DTL|02|O-00017|kxnqb1y62cggher82tae|16.00|USD|Cargo mensual|Noe|Diezmarin|Noe.diezamrin@gmail.com|5534775453
DTL|03|O-00018|ktv5ocwyohro61xmzs38|19.30|MXN|Servicio de agosto|Gonzalo|Suarez|gonzoflores@msn.com|
DTL|04|O-00019|koaayegrixktpfwsqdqn|25.91|MXN|Cargo de suscripción|Francisco|Mata|franmata@live.com|
TRL|05|04

Respuesta de Archivo de Cargos (DTL)

Respuesta del archivo de petición de cargo

DTL|1|gateway|3003|Insufficent funds||||O-00016|2017-09-14T18:29:35-06:00
DTL|2||0000|Completed|345657|tpu48wphhn8ojkr6wkij|O-00017|2017-09-14T18:32:31-06:00
DTL|3||0000|Completed|345661|tkaozuqnbtp26awb3x2p|O-00018|2017-09-14T18:36:16-06:00
DTL|4||0000|Completed|345669|ta08ivyggpwdccafl1ik|O-00019|2017-09-14T18:39:51-06:00
TRL|5|4|3|1|0000|

Devoluciones

Realizar devoluciones (DTL)

Archivo de devoluciones

DTL|01|tpu48wphhn8ojkr6wkij|kbsdfvndvptoy3q9yc1i|20.00|Cobro de servicio
DTL|02|tkaozuqnbtp26awb3x2p|kxnqb1y62cggher82tae|16.00|Cargo mensual
DTL|03|ta08ivyggpwdccafl1ik|ktv5ocwyohro61xmzs38|19.30|Servicio de agosto
DTL|04|tpu48wp18938ojk4dwij|koaayegrixktpfwsqdqn|25.91|Cargo de suscripción
TRL|05|04

Respuesta de Archivo de Devoluciones (DTL)

Respuesta del archivo de devoluciones

DTL|1|gateway|3003|Insufficent funds||||O-00016|2017-09-14T18:29:35-06:00
DTL|2||0000|Completed|345657|tpu48wphhn8ojkr6wkij|t92769tsadq5i452usd7|2017-09-14T18:32:31-06:00
DTL|3||0000|Completed|345661|tkaozuqnbtp26awb3x2p|tjhdc7t76s7ya73hhgsy|2017-09-14T18:36:16-06:00
DTL|4||0000|Completed|345669|ta08ivyggpwdccafl1ik|tus3j5ygsado23o97d54|2017-09-14T18:39:51-06:00
TRL|5|4|3|1|0000|

Subscripciones

Realizar subscripciones (DTL)

Archivo de subscripciones

DTL|1|piouqe8a78x4qwer2iuk|2017-11-20|Nikola|Tesla|nikote@mail.com|4421234567|k4jufxr9llfb2wuzihnk
DTL|2|piouqe8a78x4qwer2iuk|2017-11-20|Roberto||robert@mail.com|4421234567|ktzkxn2ksvw4fd6xs3dq
DTL|3|piouqe8a78x4qwer2iuk||James||gordon@mail.com||k8tuwjpsc6teny4a1djq
TRL|4|3

Respuesta de Archivo de Subscripciones (DTL)

Respuesta del archivo de subscripciones

DTL|1|data|9999|Record have an invalid format|||2017-11-08T10:45:04-06:00
DTL|2|data|1005|The requested resource doesn't exist|||2017-11-08T10:45:04-06:00
DTL|3||0000||s7wwnydwbw4tpoj2wenl|afeptixwgeamr0xga64c|2017-11-08T10:45:35-06:00
DTL|4||0000||s6avrtvj75qwcaq6ttmh|arpc4fzscguo061bl7no|2017-11-08T10:45:36-06:00
DTL|5||0000||sxzaittouuamqlmbuqne|a7ekvidkz7dnjfs0ohgn|2017-11-08T10:45:36-06:00
TRL|6|5|3|2|0000|

Webhooks

Openpay notificara lanzando una petición POST hacia un endpoint alojado en la aplicación del comercio. Opcionalmente el comercio puede proporcionar el usuario y password para que Openpay lánze la petición utilizando Basic Authentication.

En el cuerpo de la petición será agregado un JSON con la información relacionada al evento y al archivo que fue procesado.

POST https://mi-comercio/charges/files HTTP/1.1
Authorization: Basic VEVTVDp0ZXN0
Content-Type: application/json
{
    "type": "batch.file.finished",
    "event_date": "2017-10-06T14:02:15-05:00",
    "inputBatchFile": {
        "file_name": "TKm9blej0uw9lcq2scykny2017100301.txt",
        "public_id": "bch1urwc0b2dofnpl2cb",
        "begin_date": "2017-10-05T12:00:04-05:00",
        "finish_date": "2017-10-05T12:00:12-05:00",
        "total_records": 7,
        "type": "cards",
        "failed_records": 0,
        "success_records": 7,
        "status": "completed",
        "error_code": 0000
    }
}

Tipos de eventos

Tipos de archivos

Códigos de Error

Notas:

• Puedes simular diferentes resultados usando las tarjetas de Pruebas
• Implementa las Notificaciones para conocer el estado de los pagos en tiempo real