Api: Proceso de Inscripción y pagos con Transbank
-
Tipo Aporte
Token por
institución
Inscripción
OneClick
Finalizar Inscripción OneClick
Listado de Usuarios por Institución
Aporte Mensual OneClick
Eliminar una Inscripción
Aporte Puntual WebPay
Inscripción Patpass
Estado de Inscripción Patpass
Finalizar Aporte Puntual WebPay
Listado de Transacciones
Reversar Transacción
Tipo Aporte
Para obtener los tipos de aporte disponibles en el Api.
GET https://pagos.fundacionrecaudapais.cl/api/tipo-aporte
La respuesta será un json con la siguiente estructura
200 OK
{
"data": [
{
"id": 1,
"descripcion": "Puntual",
},
{
"id": 2,
"descripcion": "Mensual",
}
]
}
Token por institución
Para la utilización del Api, es necesario contar con un token, este debe enviarse en las cabeceras como un token de autorización.
Authorization: Bearer 94a08da1fecbb6e8b46990538c7b50b2
Inscripción OneClick
Inscripción de usuarios con aportes mensuales.
POST https://pagos.fundacionrecaudapais.cl/api/oneclick/start
| Porpiedad | Tipo | Descripción |
|---|---|---|
| aporte | integer | Id del tipo de aporte que se recibe en la petición Tipo Aporte |
| nombre | string | Nombre del usuaario que realiza el aporte |
| correo | string | Correo del usuario que realiza el aporte |
| monto | integer | Monto del aporte |
| ipc | boolean | Valor para determinar si al aporte mensual se le aplicará el reajuste por IPC |
| response_url | string | Url válida donde retornara luego de recibir la respuesta de transbank |
La respuesta será un json con el token y la url de transbank
200 OK
{
"success": "ok",
"respuesta": {
"url":
"https://webpay3gint.transbank.cl/webpayserver/bp_multicode_inscription.cgi",
"token":
"01ab74ebe8af26bfadf9b501f423d2d96b4450b452acb2ab95d6c0e26b8d431b"
}
}
Finalizar Inscripción OneClick
Para finalizar la inscripción se debe redirigir a la pasarela de pago de transbank con el token y la url obtenida en la respuesta de la inscripción de la siguiente manera
GET
https://webpay3gint.transbank.cl/webpayserver/bp_multicode_inscription.cgi?TBK_TOKEN=01ab74ebe8af26bfadf9b501f423d2d96b4450b452acb2ab95d6c0e26b8d431b
Luego de ir a la pasarela de Transbank, se puede obtener un JSON con 2 tipos de respuesta, Aprobada o Rechazada.
200 OK
{
"success": true,
"respuesta": "transaccion aprobada",
"response": {
"buyOrder": "1677262374286",
"sessionId": null,
"cardNumber": "6623",
"expirationDate": null,
"accountingDate": "0224",
"transactionDate": "2023-02-24T18:12:54.831Z"
},
"response_details": {
"amount": 2000,
"status": "AUTHORIZED",
"authorizationCode": "1213",
"paymentTypeCode": "VN",
"responseCode": 0,
"installmentsNumber": 0,
"installmentsAmount": null,
"commerceCode": "597055555542",
"buyOrder": "child-1677262374286"
},
"url_boton": "https://diseno.chiledar.cl/transbank"
}
200 OK
{
"success": false,
"respuesta": "transaccion rechazada",
"response": {
"responseCode": -1,
"tbkUser": null,
"authorizationCode": null,
"cardType": null,
"cardNumber": null
},
"url_boton": "https://diseno.chiledar.cl/transbank"
}
Listado de Usuarios por Institución
Obtendra la lista de usuarios que han realizado aportes
GET https://pagos.fundacionrecaudapais.cl/api/clients
La respuesta será un JSON con la siguiente estructura
200 OK
{
"data": [
{
"id": 55,
"username": "username",
"nombre": "Nombre del Usuario",
"email": "email@delusuario.com",
"plataforma": "OneClick",
"fecha_inscripcion": "01/01/2023",
"autorizado": 1,
"motivo_rechazo": null,
"institucion": {
"nombre": "Cuerpo de Bomberos de Santiago"
},
"tipoaporte": {
"id": 2,
"descripcion": "Mensual"
}
},
{
"id": 33,
"username": "username2",
"nombre": "Nombre del Usuario 2",
"email": "email@delusuario2.com",
"plataforma": "OneClick",
"fecha_inscripcion": "01/01/2023",
"autorizado": 1,
"motivo_rechazo": null,
"institucion": {
"nombre": "Cuerpo de Bomberos de Santiago"
},
"tipoaporte": {
"id": 2,
"descripcion": "Mensual"
}
}
}
Aporte Mensual OneClick
Para todos aquellos usuarios que se inscribieron para el aporte mensual, se podra hacer el cargo a traves de la siguiente ruta.
POST https://pagos.fundacionrecaudapais.cl/api/oneclick/aporte/client/{id_cliente}
La pasarela de transbank responderá de la siguiente manera
200 OK
{
"data": {
"success": true,
"respuesta": "transaccion aprobada",
"response": {
"buyOrder": "1677500100300",
"sessionId": null,
"cardNumber": "6623",
"expirationDate": null,
"accountingDate": "0227",
"transactionDate": "2023-02-27T12:15:00.925Z"
},
"response_details": {
"amount": 3000,
"status": "AUTHORIZED",
"authorizationCode": "1213",
"paymentTypeCode": "VN",
"responseCode": 0,
"installmentsNumber": 0,
"installmentsAmount": null,
"commerceCode": "597055555542",
"buyOrder": "1677500100300"
},
"url_boton": "https://diseno.chiledar.cl/transbank"
}
}
Eliminar una Inscripción OneClick
Anular una inscripción para aporte mensual.
GET https://pagos.fundacionrecaudapais.cl/api/oneclick/delete/client/{id_cliente}
Se puede obtener un JSON con 2 tipos de respuesta
200 OK
{
"data": {
"success": true,
"respuesta": "La inscripción ha sido eliminada satisfactoriamente",
},
}
200 OK
{
"data": {
"success": false,
"respuesta": "Imposible anular la inscripción",
},
}
Aporte Puntual WebPay
Inicio aporte puntual de usuarios.
POST https://pagos.fundacionrecaudapais.cl/api/webpay/start
| Porpiedad | Tipo | Descripción |
|---|---|---|
| aporte | integer | Id del tipo de aporte que se recibe en la petición Tipo Aporte |
| nombre | string | Nombre del usuaario que realiza el aporte |
| correo | string | Correo del usuario que realiza el aporte |
| monto | integer | Monto del aporte |
| response_url | string | Url válida donde retornara luego de recibir la respuesta de transbank |
La respuesta será un json con el token y la url de transbank
200 OK
{
"success": "ok",
"respuesta": {
"url":
"https://webpay3gint.transbank.cl/webpayserver/bp_multicode_inscription.cgi",
"token":
"01ab74ebe8af26bfadf9b501f423d2d96b4450b452acb2ab95d6c0e26b8d431b"
}
}
Finalizar Aporte Puntual WebPay
Para finalizar el aporte puntual de usuarios se debe redirigir a la pasarela de pago de transbank con el token y la url obtenida en la inicio del aporte puntual de la siguiente manera
GET
https://webpay3gint.transbank.cl/webpayserver/bp_multicode_inscription.cgi?token_ws=01ab74ebe8af26bfadf9b501f423d2d96b4450b452acb2ab95d6c0e26b8d431b
Luego de ir a la pasarela de Transbank, se puede obtener un JSON con 2 tipos de respuesta, Aprobada o Rechazada.
200 OK
{
"success": true,
"respuesta": "transaccion aprobada"
"response": {
"vci": "TSY"
"status": "AUTHORIZED"
"responseCode": 0
"amount": 3000
"authorizationCode": "1213"
"paymentTypeCode": "VN"
"accountingDate": "0227"
"installmentsNumber": 0
"installmentsAmount": null
"sessionId": "session1677506298096"
"buyOrder": "1677506298096"
"cardNumber": "6623"
"transactionDate": "2023-02-27T13:58:18.646Z"
"balance": null
}
"response_details": {
"card_number": 6623,
},
"url_boton": "https://diseno.chiledar.cl/transbank"
}
200 OK
{
"success": false,
"respuesta": "transaccion rechazada"
"response": {
"vci": "TSN"
"status": "FAILED"
"responseCode": -1
"amount": 3000
"authorizationCode": "000000"
"paymentTypeCode": "VN"
"accountingDate": "0227"
"installmentsNumber": 0
"installmentsAmount": null
"sessionId": "session1677507542367"
"buyOrder": "1677507542367"
"cardNumber": "6623"
"transactionDate": "2023-02-27T14:19:02.959Z"
"balance": null
}
"response_details": {
"card_number": 6623,
},
"url_boton": "https://diseno.chiledar.cl/transbank"
}
Inscripción Patpass
Inscripción de usuarios con Patpass.
POST https://pagos.fundacionrecaudapais.cl/api/patpass/start
| Porpiedad | Tipo | Descripción |
|---|---|---|
| aporte | integer | Id del tipo de aporte que se recibe en la petición Tipo Aporte |
| url_retorno | string | URL de retorno del comercio |
| url_inscripcion | string | Url final de la inscripción |
| servicio_id | string | ID del servicio |
| nombre | string | Nombre del suscrito |
| apellido_1 | string | Primer apellido del suscrito |
| apellido_2 | string | Segundo apellido del suscrito |
| rut | string | Rut del suscrito |
| monto | integer | Monto del aporte |
| telefono | string | Número de telefono fijo de suscrito |
| numero_celular | string | Número de telefono movíl de suscrito |
| correo | string | Correo del suscrito |
| correo_comercio | string | Correo del comercio |
| direccion | string | Dirección del suscrito |
| ciudad | string | Ciudad del suscrito |
La respuesta será un json con el token y la url de formulario de pago Patpass Comercio
200 OK
{
"success": "ok",
"respuesta": {
"url":
"https://webpay3gint.transbank.cl/webpayserver/bp_multicode_inscription.cgi",
"token":
"01ab74ebe8af26bfadf9b501f423d2d96b4450b452acb2ab95d6c0e26b8d431b"
}
}
Estado de Inscripción Patpass
Este método permite finalizar el proceso de inscripción del PAT asociado al token que se generó en la inscripción.
La respuesta de este método se debe utilizar para crear un campo de nombre tokenComercio en un formulario, al cual se le asigna el valor de token y debe ser enviado a voucherUrl.
GET
https://pagos.fundacionrecaudapais.cl/api/patpass?token_ws=01ab74ebe8af26bfadf9b501f423d2d96b4450b452acb2ab95d6c0e26b8d431b
200 OK
{
"success": true,
"respuesta": "transaccion aprobada",
"response": {
"buyOrder": "1677262374286",
"sessionId": null,
"cardNumber": "6623",
"expirationDate": null,
"accountingDate": "0224",
"transactionDate": "2023-02-24T18:12:54.831Z"
},
"response_details": {
"amount": 2000,
"status": "AUTHORIZED",
"authorizationCode": "1213",
"paymentTypeCode": "VN",
"responseCode": 0,
"installmentsNumber": 0,
"installmentsAmount": null,
"commerceCode": "597055555542",
"buyOrder": "child-1677262374286"
},
"url_boton": "https://diseno.chiledar.cl/transbank"
}
200 OK
{
"success": false,
"respuesta": "transaccion rechazada",
"response": {
"responseCode": -1,
"tbkUser": null,
"authorizationCode": null,
"cardType": null,
"cardNumber": null
},
"url_boton": "https://diseno.chiledar.cl/transbank"
}
Listado de Transacciones
Obtener el listado de transacciones de un usuario.
GET https://pagos.fundacionrecaudapais.cl/api/transactions/clients/{id_cliente}
Se obtiene un objeto con todas las transacciones del usuario
200 OK
{
"data": [
{
"id": 1,
"client_id": 1,
"orden_compra": "1677576393470",
"numero_tarjeta": "7763",
"fecha_expiracion_tarjeta": null,
"fecha_contable": "0228",
"fecha_transaccion": "2023-02-28",
"monto": 1000,
"plataforma": "oneclick",
"status": "REVERSED",
"authorization_code": "1415",
"codigo_tipo_pago": "VD",
"mensaje_tipo_pago": null,
"codigo_respuesta": "0",
"numero_cuotas": 0,
"monto_cuotas": null,
"codigo_comercio": "597055555542",
"orden_compra_hijo": "child-1677576393470",
"session_id": null,
"anulacion_authorization_code": null,
"fecha_anulacion": "2023-02-28 09:59:24",
"monto_anulacion": null,
"balance": null,
"anulacion_codigo_respuesta": null,
"user": {
"id": 1,
"username": "1677576354748",
"nombre": "Nombre Usuario",
"email": "usuario@correo.com",
"plataforma": "oneclick",
"fecha_inscripcion": "2023-02-28",
"autorizado": 1,
"motivo_rechazo": null
}
},
{
"id": 3,
"client_id": 2,
"orden_compra": "1677576480204",
"numero_tarjeta": "7060",
"fecha_expiracion_tarjeta": null,
"fecha_contable": null,
"fecha_transaccion": "2023-02-28",
"monto": 2000,
"plataforma": "webpay",
"status": "REVERSED",
"authorization_code": "1819",
"codigo_tipo_pago": "VD",
"mensaje_tipo_pago": null,
"codigo_respuesta": "0",
"numero_cuotas": 0,
"monto_cuotas": null,
"codigo_comercio": null,
"orden_compra_hijo": null,
"session_id": "session1677576480204",
"anulacion_authorization_code": null,
"fecha_anulacion": "2023-02-28 09:55:30",
"monto_anulacion": null,
"balance": null,
"anulacion_codigo_respuesta": null,
"user": {
"id": 1,
"username": "1677576354748",
"nombre": "Nombre Usuario",
"email": "usuario@correo.com",
"plataforma": "oneclick",
"fecha_inscripcion": "2023-02-28",
"autorizado": 1,
"motivo_rechazo": null
}
},
]
}
Reversar Transacción
Para reversar alguna transaccion se debe enviar el id de la transacción
GET https://pagos.fundacionrecaudapais.cl/api/refound/transaction/{transaccion}
Y se puede obtener 2 tipos de respuesta, un JSON con el mensaje "Imposible anular la transaccion" ó
uno de éxito.
En el caso de que la transacción corresponda a una reversa solo se retorna el
parámetro type (REVERSED).
200 OK
{
"data": {
"success": true,
"respuesta": "Transaccion anulada satisfactoriamente",
"response": {
"type": "REVERSED",
"authorizationCode": null,
"authorizationDate": null,
"nullifiedAmount": null,
"balance": null,
"responseCode": null
}
}
}
200 OK
{
"data": {
"success": false,
"respuesta": "Imposible anular la transaccion",
"response": null
}
}