{ "info": { "name": "Payku API — 🇨🇱 Chile (ES)", "description": "Colección oficial de la API de Payku para Chile, generada desde la especificación OpenAPI.\n\n**Antes de empezar:** importa también el entorno `payku-environment.postman_environment.json` y completa `token_pub` y `token_priv` con tus credenciales de https://app.payku.cl/.\n\n`url_api` apunta al sandbox (https://des.payku.cl). Cámbialo a https://app.payku.cl para producción.\n\n**Importante:** muchas respuestas con error llegan con HTTP 200 — revisa siempre el campo `status` del JSON.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token_pub}}", "type": "string" } ] }, "item": [ { "name": "Transacción", "item": [ { "name": "Crear transacción", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/transaction", "host": [ "{{url_api}}" ], "path": [ "api", "transaction" ] }, "description": "Este método permite crear una orden de pago a **payku** y recibe como respuesta la **URL** para redirigir el browser del pagador y el **token** que identifica la transacción.\nUna vez que el pagador efectúe el pago exitoso, **payku** notificará el resultado a la página del comercio que se envió en el parámetro **urlnotify**.\n\n**additional_parameters** = permite enviar información adicional para ser registrada en payku asociada a la transacción **order_ext** dentro de additional_parameters, es una palabra reservada, y es útil para asociar la transacción a un identificador único del comercio", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"order\": \"98745\",\n \"subject\": \"payment description\",\n \"amount\": 25000,\n \"currency\": \"CLP\",\n \"payment\": 1,\n \"expired\": \"2023-10-19 13:05:10\",\n \"urlreturn\": \"https://youwebsite.com/urlreturn?orderClient=98745\",\n \"urlnotify\": \"https://www.youwebsite.com/urlnotify?orderClient=98745\",\n \"additional_parameters\": {\n \"parameters1\": \"keyValue\",\n \"parameters2\": \"keyValue\",\n \"order_ext\": \"fff-777\",\n \"payer_rut\": \"111111111\",\n \"payer_bank\": \"0001\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/transaction", "host": [ "{{url_api}}" ], "path": [ "api", "transaction" ] }, "description": "Este método permite crear una orden de pago a **payku** y recibe como respuesta la **URL** para redirigir el browser del pagador y el **token** que identifica la transacción.\nUna vez que el pagador efectúe el pago exitoso, **payku** notificará el resultado a la página del comercio que se envió en el parámetro **urlnotify**.\n\n**additional_parameters** = permite enviar información adicional para ser registrada en payku asociada a la transacción **order_ext** dentro de additional_parameters, es una palabra reservada, y es útil para asociar la transacción a un identificador único del comercio", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"order\": \"98745\",\n \"subject\": \"payment description\",\n \"amount\": 25000,\n \"currency\": \"CLP\",\n \"payment\": 1,\n \"expired\": \"2023-10-19 13:05:10\",\n \"urlreturn\": \"https://youwebsite.com/urlreturn?orderClient=98745\",\n \"urlnotify\": \"https://www.youwebsite.com/urlnotify?orderClient=98745\",\n \"additional_parameters\": {\n \"parameters1\": \"keyValue\",\n \"parameters2\": \"keyValue\",\n \"order_ext\": \"fff-777\",\n \"payer_rut\": \"111111111\",\n \"payer_bank\": \"0001\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"pending\",\n \"id\": \"trx3b4d77b43acd9a720\",\n \"url\": \"https://BASE_URL/url_de_pago\"\n}" } ] }, { "name": "Obtener múltiples transacciones", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/transaction", "host": [ "{{url_api}}" ], "path": [ "api", "transaction" ] }, "description": "Este método permite obtener la información de las transacciones realizados en payku, este método permite una paginación con un máximo de 4000 registros por página, además, posee los siguientes filtros:\n - date_init: indica la fecha desde donde se desea comenzar la búsqueda de transacciones, si este parámetro no es enviado la busqueda iniciara la fecha actual .\n - date_end: indica la fecha donde se desea que termine la búsqueda de transacciones, si este parámetro no es enviado la busque tendrá como fecha final la fecha actual.\n - estatus: se puede filtrar la búsqueda de las transacciones dependiendo del estatus en la que se encuentra. por ejemplo. /api/transaction?success=true ó para traer multiples estatus /api/transaction?pending=true&rejected=true.\n\npara la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página. En caso de querer buscar las transacciones entre las fechas 01-09-2021 y 15-09-2021, además que solo sean las transacciones de estado success, la url a utilizar seria la siguiente: https://[URL_BASE]/api/transaction?date_init=2021-09-01&date_end=2021-09-15&success=true." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/transaction", "host": [ "{{url_api}}" ], "path": [ "api", "transaction" ] }, "description": "Este método permite obtener la información de las transacciones realizados en payku, este método permite una paginación con un máximo de 4000 registros por página, además, posee los siguientes filtros:\n - date_init: indica la fecha desde donde se desea comenzar la búsqueda de transacciones, si este parámetro no es enviado la busqueda iniciara la fecha actual .\n - date_end: indica la fecha donde se desea que termine la búsqueda de transacciones, si este parámetro no es enviado la busque tendrá como fecha final la fecha actual.\n - estatus: se puede filtrar la búsqueda de las transacciones dependiendo del estatus en la que se encuentra. por ejemplo. /api/transaction?success=true ó para traer multiples estatus /api/transaction?pending=true&rejected=true.\n\npara la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página. En caso de querer buscar las transacciones entre las fechas 01-09-2021 y 15-09-2021, además que solo sean las transacciones de estado success, la url a utilizar seria la siguiente: https://[URL_BASE]/api/transaction?date_init=2021-09-01&date_end=2021-09-15&success=true." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transaction\": [\n {\n \"id\": \"107999\",\n \"status\": \"success\",\n \"created_at\": \"2019-10-25 14:10:03\",\n \"email\": \"johndoe@example.com\",\n \"amount\": 98745,\n \"order\": \"1572023402\",\n \"subject\": \"Description\",\n \"payment\": {\n \"start\": \"2023-12-16 15:10:33\",\n \"end\": \"2023-12-16 15:10:36\",\n \"media\": \"Webpay\",\n \"transaction_id\": 107999,\n \"payment_key\": \"pra934939d607922f9e\",\n \"transaction_key\": null,\n \"deposit_date\": \"2023-10-05\",\n \"verification_key\": \"6669cbd982ef54c28f2f15fb9dc5262d\",\n \"authorization_code\": \"107742\",\n \"last_4_digits\": \"1233\",\n \"installments\": 0,\n \"card_type\": \"VN\",\n \"additional_parameters\": {\n \"identificador\": \"11.111.111-1\",\n \"banco\": \"Banco Estado\",\n \"numero_cuenta\": \"00126544977\"\n },\n \"currency\": \"CLP\"\n },\n \"nullify\": {\n \"status\": \"complete\"\n },\n \"gateway_response\": {\n \"status\": \"success\",\n \"message\": \"successful transaction\"\n }\n }\n ]\n}" } ] }, { "name": "Obtener transacción", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/transaction/:identificador", "host": [ "{{url_api}}" ], "path": [ "api", "transaction", ":identificador" ], "variable": [ { "key": "identificador", "value": "", "description": "identificador" } ] }, "description": "Este método permite obtener la información de una transacción realizado en **payku**" }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/transaction/:identificador", "host": [ "{{url_api}}" ], "path": [ "api", "transaction", ":identificador" ], "variable": [ { "key": "identificador", "value": "", "description": "identificador" } ] }, "description": "Este método permite obtener la información de una transacción realizado en **payku**" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"id\": \"trx3b4d77b43acd9a720\",\n \"created_at\": \"2019-10-25 14:10:03\",\n \"order\": \"1572023402\",\n \"email\": \"johndoe@example.com\",\n \"subject\": \"Description\",\n \"amount\": \"98745\",\n \"payment\": {\n \"start\": \"2023-12-16 15:10:33\",\n \"end\": \"2023-12-16 15:10:36\",\n \"media\": \"Webpay\",\n \"transaction_id\": 107999,\n \"payment_key\": \"pra934939d607922f9e\",\n \"transaction_key\": null,\n \"deposit_date\": \"2023-10-05\",\n \"verification_key\": \"6669cbd982ef54c28f2f15fb9dc5262d\",\n \"authorization_code\": \"107742\",\n \"last_4_digits\": \"1233\",\n \"installments\": 0,\n \"card_type\": \"VN\",\n \"additional_parameters\": {\n \"identificador\": \"11.111.111-1\",\n \"banco\": \"Banco Estado\",\n \"numero_cuenta\": \"00126544977\",\n \"network\": {\n \"ip_address\": \"192.0.2.123\"\n }\n },\n \"currency\": \"CLP\"\n },\n \"nullify\": {\n \"status\": \"complete\"\n },\n \"gateway_response\": {\n \"status\": \"success\",\n \"message\": \"successful transaction\"\n }\n}" } ] } ], "description": "Permite la creación de transacciones y posteriormente consultar su estado." }, { "name": "Transacción Escrow", "item": [ { "name": "Autorizar liquidación", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/escrow", "host": [ "{{url_api}}" ], "path": [ "api", "escrow" ] }, "description": "Este método permite autorizar la liquidación de una o más transacciones utilizando el identificador de las mismás, para que estas puedan ser depositadas en el wallet o la cuenta bancaria del cliente.", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n \"trx3b4d77b43acd9a720\",\n \"trx3b4d77b43acd9a385\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/escrow", "host": [ "{{url_api}}" ], "path": [ "api", "escrow" ] }, "description": "Este método permite autorizar la liquidación de una o más transacciones utilizando el identificador de las mismás, para que estas puedan ser depositadas en el wallet o la cuenta bancaria del cliente.", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n \"trx3b4d77b43acd9a720\",\n \"trx3b4d77b43acd9a385\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"status\": \"liquidate\",\n \"transaction_id\": \"trx3b4d77b43acd9a720\",\n \"amount\": 15000,\n \"availability_date\": \"2021-07-01\",\n \"deposit_date\": \"2021-07-06\"\n },\n {\n \"status\": \"pending\",\n \"transaction_id\": \"trx3b4d77b43bdd9a540\",\n \"amount\": 20000,\n \"availability_date\": \"2021-07-25\",\n \"deposit_date\": \"N/D\"\n }\n ]\n}" } ] } ], "description": "Esta funcionalidad permitirá a las cuentas escrow autorizadas por payku realizar la liquidación de transacciones." }, { "name": "Anulación", "item": [ { "name": "Crear anulación.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/nullification", "host": [ "{{url_api}}" ], "path": [ "api", "nullification" ] }, "description": "Este método permite crear una anulación de una transacción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"id\": \"trxpr2a45s1dytg1\",\n \"amount\": 25000,\n \"subject\": \"anulación transacción\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/nullification", "host": [ "{{url_api}}" ], "path": [ "api", "nullification" ] }, "description": "Este método permite crear una anulación de una transacción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"id\": \"trxpr2a45s1dytg1\",\n \"amount\": 25000,\n \"subject\": \"anulación transacción\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"nullify\": {\n \"id\": \"trxpr2a45s1dytg1\",\n \"amount\": 25000,\n \"currency\": \"CLP\",\n \"type\": \"total\",\n \"status_nullify\": \"complete\",\n \"payment\": {\n \"gateway\": \"webpay\",\n \"payment_type\": \"VC\"\n },\n \"created_at\": \"2023-05-17T19:12:57.189Z\",\n \"updated_at\": \"2023-05-17T19:12:57.189Z\"\n },\n \"gateway_response\": {\n \"status\": \"Successfully registered request\",\n \"message\": \"The cancellation will be executed after the amount requested is deducted from your next settlement\",\n \"notify\": \"No availability in the wallet\"\n }\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/nullification\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener anulación.", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/nullification/:identificador", "host": [ "{{url_api}}" ], "path": [ "api", "nullification", ":identificador" ], "variable": [ { "key": "identificador", "value": "", "description": "identificador" } ] }, "description": "Este método permite obtener las solicitudes de una anulación realizada a payku mediante un identificador:\n\nPara realizar la consulta es necesario agregar al final del endpoint lo siguiente /{identificador} como por ejemplo: **api/nullification/trxpr2a45s1dytg1**." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/nullification/:identificador", "host": [ "{{url_api}}" ], "path": [ "api", "nullification", ":identificador" ], "variable": [ { "key": "identificador", "value": "", "description": "identificador" } ] }, "description": "Este método permite obtener las solicitudes de una anulación realizada a payku mediante un identificador:\n\nPara realizar la consulta es necesario agregar al final del endpoint lo siguiente /{identificador} como por ejemplo: **api/nullification/trxpr2a45s1dytg1**." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nullify\": {\n \"id\": \"trxpr2a45s1dytg1\",\n \"amount\": 25000,\n \"currency\": \"CLP\",\n \"type\": \"total\",\n \"status_nullify\": \"complete\",\n \"payment\": {\n \"gateway\": \"webpay\",\n \"payment_type\": \"VC\"\n },\n \"created_at\": \"2023-05-17T19:12:57.189Z\",\n \"updated_at\": \"2023-05-17T19:12:57.189Z\"\n }\n}" } ] } ], "description": "Permite solicitar la anulación de una transacción realizada a través de payku." }, { "name": "Marketplace", "item": [ { "name": "Crear cliente", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maclient", "host": [ "{{url_api}}" ], "path": [ "api", "maclient" ] }, "description": "Este método permite la inserción de datos de un cliente.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"name\": \"John Doe\",\n \"phone\": \"923122312\",\n \"bank\": {\n \"sbif\": \"0001\",\n \"type\": \"1\",\n \"num\": \"12312313121\",\n \"rut\": \"111111111\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maclient", "host": [ "{{url_api}}" ], "path": [ "api", "maclient" ] }, "description": "Este método permite la inserción de datos de un cliente.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"name\": \"John Doe\",\n \"phone\": \"923122312\",\n \"bank\": {\n \"sbif\": \"0001\",\n \"type\": \"1\",\n \"num\": \"12312313121\",\n \"rut\": \"111111111\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"madb93fc00a2cf6f4449\",\n \"status\": \"register\",\n \"name\": \"John Doe\",\n \"phone\": \"923122312\",\n \"email\": \"johndoe@example.com\",\n \"bank\": {\n \"sbif\": \"0001\",\n \"rut\": \"111111111\",\n \"type\": 1,\n \"num\": \"12312313121\"\n },\n \"affiliations\": 0,\n \"created_at\": \"2023-09-28 20:42:59\",\n \"update_at\": \"null\"\n}" } ] }, { "name": "Obtener cliente", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite obtener el detalle de un cliente." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite obtener el detalle de un cliente." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"madb93fc00a2cf6f4449\",\n \"status\": \"register\",\n \"name\": \"John Doe\",\n \"phone\": \"923122312\",\n \"email\": \"johndoe@example.com\",\n \"bank\": {\n \"sbif\": \"0001\",\n \"rut\": \"111111111\",\n \"type\": 1,\n \"num\": \"12312313121\"\n },\n \"affiliations\": 0,\n \"created_at\": \"2023-09-28 20:42:59\",\n \"update_at\": \"null\"\n}" } ] }, { "name": "Actualizar cliente", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/maclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la actualización de los datos de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"name\": \"John Doe Doe\",\n \"phone\": \"923122312\",\n \"bank\": {\n \"sbif\": \"0001\",\n \"type\": 3,\n \"num\": \"9999999\",\n \"rut\": \"111111111\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/maclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la actualización de los datos de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"name\": \"John Doe Doe\",\n \"phone\": \"923122312\",\n \"bank\": {\n \"sbif\": \"0001\",\n \"type\": 3,\n \"num\": \"9999999\",\n \"rut\": \"111111111\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cl0be4c8e623c167bc8b777\",\n \"status\": \"register\",\n \"name\": \"John Doe\",\n \"phone\": \"923122312\",\n \"email\": \"923122312\",\n \"bank\": {\n \"sbif\": \"0001\",\n \"type\": \"3\",\n \"num\": \"9999999\",\n \"rut\": \"261009617\"\n },\n \"affiliations\": 2,\n \"affiliations_details\": [\n [\n {\n \"id\": \"s6df85b41df65b21se685\",\n \"status\": \"register\",\n \"token\": \"sgh65g1ns6fg5n1sfg2sr6j5nfg65shr6gh5s4r6h5fg6\",\n \"name\": \"market1\",\n \"percentage_affiliation\": 1,\n \"percentage_client\": 99\n },\n {\n \"id\": \"s6df85b41df65b21se685\",\n \"status\": \"register\",\n \"token\": \"sgh65g1ns6fg5n1sfg2sr6j5nfg65shr6gh5s4r6h5fg6\",\n \"name\": \"market2\",\n \"percentage_affiliation\": 1,\n \"percentage_client\": 99\n }\n ]\n ]\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/maclient/{identificadorCliente}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Eliminar cliente", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la eliminación de un cliente asociado a un ID de usuario." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la eliminación de un cliente asociado a un ID de usuario." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"suspended\",\n \"id\": \"madb93fc00a2cf6f4449\"\n}" } ] }, { "name": "Crear afiliación", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maaffiliation", "host": [ "{{url_api}}" ], "path": [ "api", "maaffiliation" ] }, "description": "Este método permite registrar los datos para la afiliación.", "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"percentage\": \"20\",\n \"affiliation\": [\n [\n \"madb93fc00a2cf6f4449\",\n \"80\"\n ]\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maaffiliation", "host": [ "{{url_api}}" ], "path": [ "api", "maaffiliation" ] }, "description": "Este método permite registrar los datos para la afiliación.", "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"percentage\": \"20\",\n \"affiliation\": [\n [\n \"madb93fc00a2cf6f4449\",\n \"80\"\n ]\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"sucaab7865dceaff49d8b3\",\n \"status\": \"register\",\n \"name\": \"name\",\n \"token\": \"eecd92fdbb8bf615e8215d6fbb30bb6ae6f82c9e1810f85b65bbeb472794c4a4\",\n \"percentage\": \"20.00\",\n \"affiliations\": [\n {\n \"id\": \"ma9fd16221a9645b0036\",\n \"name\": \"name\",\n \"percentage\": \"80.00\"\n }\n ]\n}" } ] }, { "name": "Obtener afiliación", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maaffiliation/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maaffiliation", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite obtener el detalle de una afiliación." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maaffiliation/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maaffiliation", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite obtener el detalle de una afiliación." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"sucaab7865dceaff49d8b3\",\n \"status\": \"register\",\n \"name\": \"name\",\n \"token\": \"eecd92fdbb8bf615e8215d6fbb30bb6ae6f82c9e1810f85b65bbeb472794c4a4\",\n \"percentage\": \"20.00\",\n \"affiliations\": [\n {\n \"id\": \"ma9fd16221a9645b0036\",\n \"name\": \"name\",\n \"percentage\": \"80.00\"\n }\n ]\n}" } ] }, { "name": "Eliminar afiliación", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maaffiliation/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maaffiliation", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la eliminación de una afiliación asociada a un ID." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/maaffiliation/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "maaffiliation", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la eliminación de una afiliación asociada a un ID." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"suspended\",\n \"id\": \"maab4462d6133e05e518\"\n}" } ] }, { "name": "Crear transacción marketplace", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/transaction", "host": [ "{{url_api}}" ], "path": [ "api", "transaction" ] }, "description": "Este método permite crear una orden de pago a **payku** y recibe como respuesta la **URL** para redirigir el browser del pagador y el **token** que identifica la transacción. Una vez que el pagador efectúe el pago exitoso, **payku** notificará el resultado a la página del comercio que se envió en el parámetro **urlnotify**.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"order\": \"98745\",\n \"subject\": \"payment description\",\n \"amount\": 25000,\n \"payment\": 1,\n \"urlreturn\": \"https://youwebsite.com/urlreturn?orderClient=98745\",\n \"urlnotify\": \"https://www.youwebsite.com/urlnotify?orderClient=98745\",\n \"marketplace\": \"c1c879f4862d393ea6b326a313022dd98f0baa2869d3e9095c124199c9941030\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/transaction", "host": [ "{{url_api}}" ], "path": [ "api", "transaction" ] }, "description": "Este método permite crear una orden de pago a **payku** y recibe como respuesta la **URL** para redirigir el browser del pagador y el **token** que identifica la transacción. Una vez que el pagador efectúe el pago exitoso, **payku** notificará el resultado a la página del comercio que se envió en el parámetro **urlnotify**.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"order\": \"98745\",\n \"subject\": \"payment description\",\n \"amount\": 25000,\n \"payment\": 1,\n \"urlreturn\": \"https://youwebsite.com/urlreturn?orderClient=98745\",\n \"urlnotify\": \"https://www.youwebsite.com/urlnotify?orderClient=98745\",\n \"marketplace\": \"c1c879f4862d393ea6b326a313022dd98f0baa2869d3e9095c124199c9941030\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"pending\",\n \"id\": \"trx3b4d77b43acd9a720\",\n \"url\": \"https://BASE_URL/url_de_pago\"\n}" } ] } ], "description": "Permite el registro de clientes, para posteriormente realizar la distribución según porcentaje asignado." }, { "name": "Mall", "item": [ { "name": "Crear transacción Mall", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/mall", "host": [ "{{url_api}}" ], "path": [ "api", "mall" ] }, "description": "Esto método permite la inserción de datos de una transacción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"joedoe@example.com\",\n \"payment\": 1,\n \"merchant\": [\n [\n \"81b6179e4feeef2b50af71d660f830de\",\n 30000,\n \"item1\",\n null,\n \"4545\"\n ],\n [\n \"81b6179e4feeef2b50af71d66f7830de\",\n 25000,\n \"item2\",\n null,\n \"4546\"\n ],\n [\n \"81b6179e4fffff2b50af71d66f7830de\",\n 15000,\n \"item3\",\n null,\n \"4547\"\n ]\n ],\n \"order\": 123,\n \"urlreturn\": \"https://youwebsite.com/urlreturn\",\n \"urlnotify\": \"https://youwebsite.com/urlnotify\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/mall", "host": [ "{{url_api}}" ], "path": [ "api", "mall" ] }, "description": "Esto método permite la inserción de datos de una transacción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"joedoe@example.com\",\n \"payment\": 1,\n \"merchant\": [\n [\n \"81b6179e4feeef2b50af71d660f830de\",\n 30000,\n \"item1\",\n null,\n \"4545\"\n ],\n [\n \"81b6179e4feeef2b50af71d66f7830de\",\n 25000,\n \"item2\",\n null,\n \"4546\"\n ],\n [\n \"81b6179e4fffff2b50af71d66f7830de\",\n 15000,\n \"item3\",\n null,\n \"4547\"\n ]\n ],\n \"order\": 123,\n \"urlreturn\": \"https://youwebsite.com/urlreturn\",\n \"urlnotify\": \"https://youwebsite.com/urlnotify\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"id\": \"malld200058ab44739ddee2adcd2f5\",\n \"individual_orders\": [\n {\n \"merchant\": \"81b6179e4feeef2b50af71d660f830de\",\n \"amount\": 30000,\n \"subject\": \"item1\",\n \"event\": null,\n \"identificador\": \"9917068816213146\",\n \"individual_order\": \"9654\"\n },\n {\n \"merchant\": \"81b6179e4feeef2b50af71d66f7830de\",\n \"amount\": 25000,\n \"subject\": \"item2\",\n \"event\": null,\n \"identificador\": \"9917068816213146\",\n \"individual_order\": \"9654\"\n },\n {\n \"merchant\": \"81b6179e4fffff2b50af71d66f7830de\",\n \"amount\": 15000,\n \"subject\": \"item3\",\n \"event\": null,\n \"identificador\": \"9917068816213146\",\n \"individual_order\": \"9654\"\n }\n ],\n \"url\": \"https://BASE_URL/gateway/mall/malld200058ab44739ddee2adcd2f5\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/mall\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener transacción Mall", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/mall/:identificadortrasaccion", "host": [ "{{url_api}}" ], "path": [ "api", "mall", ":identificadortrasaccion" ], "variable": [ { "key": "identificadortrasaccion", "value": "", "description": "identificadorTrasaccion" } ] }, "description": "Este método permite obtener la información de un pago realizado en **payku**" }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/mall/:identificadortrasaccion", "host": [ "{{url_api}}" ], "path": [ "api", "mall", ":identificadortrasaccion" ], "variable": [ { "key": "identificadortrasaccion", "value": "", "description": "identificadorTrasaccion" } ] }, "description": "Este método permite obtener la información de un pago realizado en **payku**" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"id\": \"malld200058ab44739ddee2adcd2f5\",\n \"created_at\": \"2023-10-16 11:23:19\",\n \"amount\": \"30000\",\n \"payment\": {\n \"media\": \"Webpay\",\n \"verification_key\": \"d60aaa661ea74d824373806c8aa38137\",\n \"authorization_code\": \"441864\",\n \"last_4_digits\": \"5135\",\n \"card_type\": \"\",\n \"currency\": \"CLP\"\n },\n \"merchant\": [\n {\n \"name\": \"John Doe\",\n \"amount\": 30000,\n \"subject\": \"item1\"\n },\n {\n \"name\": \"Jane Doe\",\n \"amount\": 25000,\n \"subject\": \"item2\"\n },\n {\n \"name\": \"Enteprise\",\n \"amount\": 15000,\n \"subject\": \"item3\"\n }\n ]\n}" } ] } ], "description": "El producto ha sido diseñado especialmente para aquellas empresas integradoras de distintas marcas con diferentes líneas de negocio las cuales pueden agruparse manteniendo su diversidad en un mismo espacio virtual o mall.\n\nOfreciendo la posibilidad de agrupar el pago de las compras realizadas en múltiples tiendas virtuales en una sola transacción." }, { "name": "Evento", "item": [ { "name": "Crear un evento", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/event", "host": [ "{{url_api}}" ], "path": [ "api", "event" ] }, "description": "Este método permite crear un evento y recibir como respuesta el detalle del evento.", "body": { "mode": "raw", "raw": "{\n \"event\": \"98374\",\n \"name\": \"Event\",\n \"date_event\": \"2023-12-20\",\n \"date_closing_sales\": \"2023-12-19 23:59:00\",\n \"date_payment\": \"2023-12-20\",\n \"url_event\": \"https://www.example.com/event1\",\n \"url_logo\": \"https://www.example.com/logo_event1.png\",\n \"service_sale\": 10,\n \"affiliation\": [\n {\n \"email\": \"afiliate1@domain.com\",\n \"percent\": 50\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/event", "host": [ "{{url_api}}" ], "path": [ "api", "event" ] }, "description": "Este método permite crear un evento y recibir como respuesta el detalle del evento.", "body": { "mode": "raw", "raw": "{\n \"event\": \"98374\",\n \"name\": \"Event\",\n \"date_event\": \"2023-12-20\",\n \"date_closing_sales\": \"2023-12-19 23:59:00\",\n \"date_payment\": \"2023-12-20\",\n \"url_event\": \"https://www.example.com/event1\",\n \"url_logo\": \"https://www.example.com/logo_event1.png\",\n \"service_sale\": 10,\n \"affiliation\": [\n {\n \"email\": \"afiliate1@domain.com\",\n \"percent\": 50\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"id\": \"98374\",\n \"event\": \"Event\",\n \"date_event\": \"2023-12-20\",\n \"date_payment\": \"2023-12-22\",\n \"date_closing_sales\": \"2023-12-19 23:59:00\",\n \"url_logo\": \"https://www.example.com/logo_event1.png\",\n \"url_event\": \"https://www.example.com/event1\",\n \"distribution\": {\n \"affiliate\": \"100.00\",\n \"service_sale\": \"10.00\"\n },\n \"affiliation\": [\n {\n \"id\": \"b99dfd8193ebfd37d4b9\",\n \"email\": \"afiliate1@domain.com\",\n \"percent\": \"100.00\",\n \"status\": \"pending\"\n }\n ]\n}" } ] }, { "name": "Obtener evento", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/event/:identificadorevento", "host": [ "{{url_api}}" ], "path": [ "api", "event", ":identificadorevento" ], "variable": [ { "key": "identificadorevento", "value": "", "description": "identificadorEvento" } ] }, "description": "Este método permite obtener el detalle de un evento." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/event/:identificadorevento", "host": [ "{{url_api}}" ], "path": [ "api", "event", ":identificadorevento" ], "variable": [ { "key": "identificadorevento", "value": "", "description": "identificadorEvento" } ] }, "description": "Este método permite obtener el detalle de un evento." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"98374\",\n \"event\": \"Event\",\n \"date_event\": \"2023-12-20\",\n \"date_payment\": \"2023-12-22\",\n \"date_closing_sales\": \"2023-12-19 23:59:00\",\n \"url_logo\": \"https://www.example.com/logo_event1.png\",\n \"url_event\": \"https://www.example.com/event1\",\n \"distribution\": {\n \"affiliate\": \"100.00\",\n \"service_sale\": \"10.00\"\n },\n \"affiliations\": [\n {\n \"id\": \"b99dfd8193ebfd37d4b9\",\n \"email\": \"afiliate1@domain.com\",\n \"percent\": \"100.00\",\n \"status\": \"pending\"\n }\n ]\n}" } ] } ], "description": "Permite la creación de eventos y posteriormente consultar su estado." }, { "name": "Suscripción", "item": [ { "name": "Crear cliente", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient", "host": [ "{{url_api}}" ], "path": [ "api", "suclient" ] }, "description": "Este método permite la inserción de datos de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"name\": \"John Doe\",\n \"rut\": \"11111111\",\n \"phone\": \"923122312\",\n \"address\": \"Moneda 101\",\n \"country\": \"Chile\",\n \"region\": \"Metropolitana\",\n \"city\": \"Santiago\",\n \"postal_code\": \"850000\",\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient", "host": [ "{{url_api}}" ], "path": [ "api", "suclient" ] }, "description": "Este método permite la inserción de datos de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"name\": \"John Doe\",\n \"rut\": \"11111111\",\n \"phone\": \"923122312\",\n \"address\": \"Moneda 101\",\n \"country\": \"Chile\",\n \"region\": \"Metropolitana\",\n \"city\": \"Santiago\",\n \"postal_code\": \"850000\",\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"active\",\n \"id\": \"cl0be4c8e623c167bc8b777\",\n \"rut\": \"11111111\",\n \"name\": \"John Doe\",\n \"phone\": \"923122312\",\n \"email\": \"johndoe@example.com\",\n \"address\": \"Moneda 101\",\n \"country\": \"Chile\",\n \"region\": \"Metropolitana\",\n \"city\": \"Santiago\",\n \"postal_code\": \"850000\",\n \"created_at\": \"2023-09-29\",\n \"update_at\": null,\n \"subcriptions\": null,\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n }\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suclient\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener cliente", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "suclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite obtener el detalle de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "suclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite obtener el detalle de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"active\",\n \"id\": \"cl0be4c8e623c167bc8b777\",\n \"rut\": \"11111111\",\n \"name\": \"John Doe\",\n \"phone\": \"923122312\",\n \"email\": \"johndoe@example.com\",\n \"address\": \"Moneda 101\",\n \"city\": \"Santiago\",\n \"region\": \"Metropolitana\",\n \"country\": \"Chile\",\n \"postal_code\": \"850000\",\n \"created_at\": \"2023-09-29 22:00:00\",\n \"update_at\": null,\n \"active_cards\": [\n {\n \"last_4_digits\": \"XXXXXXXXXXXX6622\",\n \"identifier\": \"surec804a8ed60c747cb8839\",\n \"card_type\": \"Visa\",\n \"register\": \"2023-07-26 08:00:19\"\n },\n {\n \"last_4_digits\": \"XXXXXXXXXXXX1234\",\n \"identifier\": \"surec804a8ed60c747cb8843\",\n \"card_type\": \"MasterCard\",\n \"register\": \"2023-01-01 12:00:00\"\n }\n ],\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n },\n \"subcriptions\": {\n \"id\": \"su867f07772aa5f5175527\",\n \"created_at\": \"2023-09-29 19:58:35\",\n \"status\": \"active\",\n \"amount\": \"15000\",\n \"plan\": [\n {\n \"id\": \"pl9697fb170834ad42dd00\",\n \"name\": \"test plan\",\n \"currency\": \"CLP\"\n }\n ],\n \"cards\": [\n {\n \"last_4_digits\": \"XXXXXXXXXXXX6623\",\n \"card_type\": \"Visa\"\n }\n ],\n \"transactions\": [\n {\n \"created_at\": \"2023-09-30 19:58:35\",\n \"date_payment\": \"2023-09-30\",\n \"amount\": 10000,\n \"transaction\": 204444,\n \"authorization_code\": \"1234\",\n \"order\": \"001\",\n \"description\": \"descripcion\",\n \"status\": \"success\"\n }\n ]\n }\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suclient/{identificadorCliente}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Actualizar cliente", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "suclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la actualización de los datos de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"name\": \"John Doe Doe\",\n \"phone\": \"923122312\",\n \"address\": \"Moneda 121\",\n \"country\": \"Chile\",\n \"region\": \"Metropolitana\",\n \"city\": \"Santiago\",\n \"postal_code\": \"750000\",\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "suclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la actualización de los datos de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"name\": \"John Doe Doe\",\n \"phone\": \"923122312\",\n \"address\": \"Moneda 121\",\n \"country\": \"Chile\",\n \"region\": \"Metropolitana\",\n \"city\": \"Santiago\",\n \"postal_code\": \"750000\",\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"active\",\n \"id\": \"cl0be4c8e623c167bc8b777\",\n \"name\": \"John Doe Doe\",\n \"phone\": \"923122312\",\n \"email\": \"johndoe@example.com\",\n \"address\": \"Moneda 121\",\n \"city\": \"Santiago\",\n \"region\": \"Metropolitana\",\n \"country\": \"Chile\",\n \"postal_code\": \"750000\",\n \"created_at\": \"2023-09-29 22:00:00\",\n \"update_at\": \"2023-10-2 08:32:52\",\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n },\n \"subcriptions\": {\n \"id\": \"su867f07772aa5f5175527\",\n \"created_at\": \"2023-09-29 19:58:35\",\n \"status\": \"active\",\n \"amount\": \"15000\",\n \"plan\": [\n {\n \"id\": \"pl9697fb170834ad42dd00\",\n \"name\": \"test plan\",\n \"currency\": \"CLP\"\n }\n ],\n \"cards\": [\n {\n \"last_4_digits\": \"XXXXXXXXXXXX6623\",\n \"card_type\": \"Visa\"\n }\n ],\n \"transactions\": [\n {\n \"created_at\": \"2023-09-30 19:58:35\",\n \"date_payment\": \"2023-09-30\",\n \"amount\": 10000,\n \"transaction\": 204444,\n \"authorization_code\": \"1234\",\n \"order\": \"001\",\n \"description\": \"descripcion\",\n \"status\": \"success\"\n }\n ]\n }\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suclient/{identificadorCliente}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Eliminar cliente", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "suclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la eliminación de un cliente asociado a un ID de usuario.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient/:identificadorcliente", "host": [ "{{url_api}}" ], "path": [ "api", "suclient", ":identificadorcliente" ], "variable": [ { "key": "identificadorcliente", "value": "", "description": "identificadorCliente" } ] }, "description": "Este método permite la eliminación de un cliente asociado a un ID de usuario.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"id\": \"cl0be4c8e623c167bc8b777\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suclient/{identificadorCliente}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener clientes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient/customers", "host": [ "{{url_api}}" ], "path": [ "api", "suclient", "customers" ] }, "description": "Este método permite obtener todos los clientes asociados a un ID de usuario , este método permite una paginación con un máximo de 100 registros por página, además, posee un filtro de fecha, si este parámetro no es ingresado se tomará la fecha actual, para la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient/customers", "host": [ "{{url_api}}" ], "path": [ "api", "suclient", "customers" ] }, "description": "Este método permite obtener todos los clientes asociados a un ID de usuario , este método permite una paginación con un máximo de 100 registros por página, además, posee un filtro de fecha, si este parámetro no es ingresado se tomará la fecha actual, para la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Customers\": [\n {\n \"last_4_digits\": \"XXXXXXXXXXXX6622\",\n \"identifier\": \"surec804a8ed60c747cb8839\",\n \"card_type\": \"Visa\",\n \"register\": \"2023-07-26 08:00:19\"\n },\n {\n \"last_4_digits\": \"XXXXXXXXXXXX1234\",\n \"identifier\": \"surec804a8ed60c747cb8843\",\n \"card_type\": \"MasterCard\",\n \"register\": \"2023-01-01 12:00:00\",\n \"additional_parameters\": {\n \"type\": \"array\",\n \"description\": \"Parámetros adicionales que puede enviar payku.\",\n \"example\": \"\"\n },\n \"subcriptions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"description\": \"Identificador de la suscripción creado por payku.\",\n \"type\": \"string\",\n \"example\": \"su867f07772aa5f5175527\"\n },\n \"created_at\": {\n \"description\": \"Fecha de registro.\",\n \"type\": \"string\",\n \"example\": \"2023-09-29 19:58:35\",\n \"format\": \"datetime\"\n },\n \"status\": {\n \"description\": \"Estatus de la suscripción. Los posibles estados que puede obtener son los siguientes:\\n- register\\n- active\\n- finish\\n- delete\\n- cancel\\n- suspended\\n\",\n \"type\": \"string\",\n \"example\": \"active\"\n },\n \"amount\": {\n \"description\": \"Monto de la suscripción.\",\n \"type\": \"string\",\n \"example\": \"15000\"\n },\n \"plan\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"description\": \"Identificador del plan creado por payku.\",\n \"type\": \"string\",\n \"example\": \"pl9697fb170834ad42dd00\"\n },\n \"name\": {\n \"description\": \"Nombre del plan.\",\n \"type\": \"string\",\n \"example\": \"test plan\"\n },\n \"currency\": {\n \"description\": \"Moneda.\",\n \"type\": \"string\",\n \"example\": \"CLP\"\n }\n }\n }\n },\n \"cards\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"last_4_digits\": {\n \"description\": \"Últimos 4 dígitos de la tarjeta afiliada.\",\n \"type\": \"string\",\n \"example\": \"XXXXXXXXXXXX6623\"\n },\n \"card_type\": {\n \"description\": \"Tipo de tarjeta.\",\n \"type\": \"string\",\n \"example\": \"Visa\"\n }\n }\n }\n },\n \"transactions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"created_at\": {\n \"description\": \"Fecha de creación de la transacción.\",\n \"type\": \"string\",\n \"example\": \"2023-09-30 19:58:35\"\n },\n \"date_payment\": {\n \"description\": \"Fecha en que se realizo la transacción.\",\n \"type\": \"string\",\n \"example\": \"2023-09-30\"\n },\n \"amount\": {\n \"description\": \"Monto de transacción.\",\n \"type\": \"int\",\n \"example\": 10000\n },\n \"transaction\": {\n \"description\": \"Número de transacción.\",\n \"type\": \"int\",\n \"example\": 204444\n },\n \"authorization_code\": {\n \"description\": \"Código de autorización.\",\n \"type\": \"string\",\n \"example\": \"1234\"\n },\n \"order\": {\n \"description\": \"Número de orden.\",\n \"type\": \"string\",\n \"example\": \"001\"\n },\n \"description\": {\n \"description\": \"Descripción.\",\n \"type\": \"string\",\n \"example\": \"descripcion\"\n },\n \"status\": {\n \"description\": \"Estatus de transacción.Los posibles estados que puede obtener son los siguientes:\\n- pending\\n- success\\n- retry\\n- canceled by customer\\n- canceled by paymaster\\n- canceled by payku\\n- maximum attempt limit\\n- first payment rejected\\n- payment consumes failed\\n\",\n \"type\": \"string\",\n \"example\": \"success\"\n }\n }\n }\n }\n }\n }\n }\n }\n ]\n }\n]" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suclient/customers\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Crear suscripción", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription" ] }, "description": "Este método permite al usuario de una cuenta payku crear una suscripción a un plan de suscripción de monto fijo, suscripción de plan de consumo y suscripción de monto variable a uno de sus clientes, para este ultimo tipo de suscripción es necesario enviar el monto que sera cobrado en la suscripción, es importante destacar que al realizar esta solicitud por primera vez se realizará un cobro de $50 que permite comprobar que la tarjeta se encuentra activa y es válida, en el caso de un plan de suscripción fijo el cobro del servicio será automático a partir del mes siguiente de la fecha de suscripción y en el caso que la suscripción sea a un plan de consumo será necesario utilizar el endpoint api/sutransaction para generar la transacción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"plan\": \"pl9697fb170834ad42dd00\",\n \"client\": \"cl9b1e1dd988694f30fa30\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription" ] }, "description": "Este método permite al usuario de una cuenta payku crear una suscripción a un plan de suscripción de monto fijo, suscripción de plan de consumo y suscripción de monto variable a uno de sus clientes, para este ultimo tipo de suscripción es necesario enviar el monto que sera cobrado en la suscripción, es importante destacar que al realizar esta solicitud por primera vez se realizará un cobro de $50 que permite comprobar que la tarjeta se encuentra activa y es válida, en el caso de un plan de suscripción fijo el cobro del servicio será automático a partir del mes siguiente de la fecha de suscripción y en el caso que la suscripción sea a un plan de consumo será necesario utilizar el endpoint api/sutransaction para generar la transacción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"plan\": \"pl9697fb170834ad42dd00\",\n \"client\": \"cl9b1e1dd988694f30fa30\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"register\",\n \"id\": \"sucaab7865dceaff49d8b3\",\n \"url\": \"http://BASE_URL/gateway/registrosuscripcion?tipoplan=2&plan=true&token=219&validacion=e6c50ba0e0\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/sususcription\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener suscripciones", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription" ] }, "description": "Este método permite obtener todos las suscripciones asociados a un ID de usuario , este método permite una paginación con un máximo de registros por página, además, posee un filtro de fecha, si este parámetro no es ingresado se tomará la fecha actual, para la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página. estatus: se puede filtrar la búsqueda de las suscripciones dependiendo del estatus que se desea buscar agregando el estatus a buscar igual a true, en caso de no agregar ninguno por defecto se buscaran todas las suscripciones sin discriminar por su estatus.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription" ] }, "description": "Este método permite obtener todos las suscripciones asociados a un ID de usuario , este método permite una paginación con un máximo de registros por página, además, posee un filtro de fecha, si este parámetro no es ingresado se tomará la fecha actual, para la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página. estatus: se puede filtrar la búsqueda de las suscripciones dependiendo del estatus que se desea buscar agregando el estatus a buscar igual a true, en caso de no agregar ninguno por defecto se buscaran todas las suscripciones sin discriminar por su estatus.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"subscriptions\": [\n {\n \"id\": \"sucaab7865dceaff49d8b7\",\n \"status\": \"active\",\n \"last_status_current_payment\": \"pending\",\n \"start\": \"2019-07-22 18:34:49\",\n \"end\": \"2023-06-12 00:00:00\",\n \"client\": {\n \"id\": \"su7e5e1c0b1bd2e37ec557\",\n \"name\": \"name\",\n \"email\": \"johndoe@example.com\",\n \"rut\": \"11.111.111-1\",\n \"phone\": \"56928265454\",\n \"parámetros\": [],\n \"additional_parameters\": \"\"\n },\n \"plan\": {\n \"id\": \"pl9697fb170834ad42dd00\",\n \"name\": \"test plan\",\n \"currency\": \"CLP\"\n },\n \"cards\": {\n \"last_4_digits\": \"XXXXXXXXXXXX6622\",\n \"card_type\": \"Visa\"\n },\n \"transactions\": [\n {\n \"created_at\": \"2023-09-30 19:58:35\",\n \"amount\": 10000,\n \"transaction\": 204444,\n \"authorization_code\": \"1234\",\n \"order\": \"001\",\n \"description\": \"descripcion\",\n \"status\": \"success\"\n }\n ],\n \"logs\": {\n \"status\": [\n {\n \"change_date\": null,\n \"initial_status\": null,\n \"final_status\": null\n }\n ]\n }\n }\n ]\n }\n]" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/sususcription\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener suscripciones V3", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcriptionv3", "host": [ "{{url_api}}" ], "path": [ "api", "sususcriptionv3" ] }, "description": "Este método permite obtener todos las suscripciones asociados a un ID de usuario , este método permite una paginación con un máximo de 4000 registros por página, además, posee los siguientes filtros:\n\ndate_init: indica la fecha desde donde se desea comenzar la búsqueda de suscripciones, si este parámetro no es enviado la busqueda iniciara la fecha actual .\ndate_end: indica la fecha donde se desea que termine la búsqueda de suscripciones, si este parámetro no es enviado la busque tendrá como fecha final la fecha actual.\nestatus: se puede filtrar la búsqueda de las suscripciones dependiendo del estatus que se desea buscar agregando el estatus a buscar igual a true, en caso de no agregar ninguno por defecto se buscaran todas las suscripciones sin discriminar por su estatus.\n\npara la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página. En caso de querer buscar las suscripciones entre las fechas 01-09-2021 y 15-09-2021, además que solo sean las suscripciones de estado active, la url a utilizar seria la siguiente: https://[URL_BASE]/api/sususcriptionv3?date_init=2021-09-01&date_end=2021-09-15&active=true.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcriptionv3", "host": [ "{{url_api}}" ], "path": [ "api", "sususcriptionv3" ] }, "description": "Este método permite obtener todos las suscripciones asociados a un ID de usuario , este método permite una paginación con un máximo de 4000 registros por página, además, posee los siguientes filtros:\n\ndate_init: indica la fecha desde donde se desea comenzar la búsqueda de suscripciones, si este parámetro no es enviado la busqueda iniciara la fecha actual .\ndate_end: indica la fecha donde se desea que termine la búsqueda de suscripciones, si este parámetro no es enviado la busque tendrá como fecha final la fecha actual.\nestatus: se puede filtrar la búsqueda de las suscripciones dependiendo del estatus que se desea buscar agregando el estatus a buscar igual a true, en caso de no agregar ninguno por defecto se buscaran todas las suscripciones sin discriminar por su estatus.\n\npara la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página. En caso de querer buscar las suscripciones entre las fechas 01-09-2021 y 15-09-2021, además que solo sean las suscripciones de estado active, la url a utilizar seria la siguiente: https://[URL_BASE]/api/sususcriptionv3?date_init=2021-09-01&date_end=2021-09-15&active=true.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"subscriptions\": [\n {\n \"id\": \"sucaab7865dceaff49d8b7\",\n \"estatus\": \"active\",\n \"start\": \"2019-07-22 18:34:49\",\n \"end\": \"2023-06-12 00:00:00\",\n \"client\": {\n \"id\": \"su7e5e1c0b1bd2e37ec557\",\n \"name\": \"name\",\n \"email\": \"johndoe@example.com\",\n \"rut\": \"11.111.111-1\",\n \"phone\": \"56928265454\",\n \"parámetros\": [],\n \"additional_parameters\": \"\"\n },\n \"plan\": {\n \"id\": \"pl9697fb170834ad42dd00\",\n \"name\": \"test plan\",\n \"currency\": \"CLP\"\n },\n \"active_cards\": {\n \"last_4_digits\": \"XXXXXXXXXXXX6622\",\n \"card_type\": \"Visa\"\n },\n \"logs\": {\n \"status\": [\n {\n \"change_date\": null,\n \"initial_status\": null,\n \"final_status\": null\n }\n ]\n },\n \"paid\": [\n {\n \"payment_cycle_day\": \"2021-07-09\",\n \"payment_day\": \"2021-07-09\",\n \"status\": \"success\",\n \"amount_paid\": 2500,\n \"try_number\": 1,\n \"paid_number\": 1,\n \"transactions\": []\n }\n ]\n }\n ]\n }\n]" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/sususcriptionv3\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Crear transacción", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sutransaction", "host": [ "{{url_api}}" ], "path": [ "api", "sutransaction" ] }, "description": "Este método permite al usuario de una cuenta payku generar una transacción única a uno de sus clientes que encuentre suscrito a un plan de consumo.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"sucaab7865dceaff49d8b3\",\n \"amount\": \"10000\",\n \"order\": \"001\",\n \"description\": \"Descripción\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sutransaction", "host": [ "{{url_api}}" ], "path": [ "api", "sutransaction" ] }, "description": "Este método permite al usuario de una cuenta payku generar una transacción única a uno de sus clientes que encuentre suscrito a un plan de consumo.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"sucaab7865dceaff49d8b3\",\n \"amount\": \"10000\",\n \"order\": \"001\",\n \"description\": \"Descripción\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"order\": \"001\",\n \"amount\": \"10000\",\n \"transaction_id\": \"204444\",\n \"verification_key\": \"025dcad37e071daa8bfc2df35189009db65692a4ff766856108be1675e870839\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/sutransaction\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener suscripción", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription/:identificadorsuscripcion", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription", ":identificadorsuscripcion" ], "variable": [ { "key": "identificadorsuscripcion", "value": "", "description": "identificadorSuscripcion" } ] }, "description": "Este método permite obtener el detalle de una suscripción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription/:identificadorsuscripcion", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription", ":identificadorsuscripcion" ], "variable": [ { "key": "identificadorsuscripcion", "value": "", "description": "identificadorSuscripcion" } ] }, "description": "Este método permite obtener el detalle de una suscripción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"sucaab7865dceaff49d8b7\",\n \"status\": \"active\",\n \"start\": \"2019-07-22 18:34:49\",\n \"end\": \"2023-06-12 00:00:00\",\n \"client\": {\n \"id\": \"cld0835b9063a5903f4ae7\",\n \"name\": \"name\",\n \"email\": \"joedoe@example.com\",\n \"rut\": \"11.111.111-1\",\n \"phone\": \"56972756487\",\n \"parámetros\": [],\n \"additional_parameters\": \"\"\n },\n \"plan\": {\n \"id\": \"pl9697fb170834ad42dd00\",\n \"name\": \"test plan\",\n \"currency\": \"CLP\"\n },\n \"cards\": {\n \"last_4_digits\": \"XXXXXXXXXXXX6622\",\n \"card_type\": \"Visa\"\n },\n \"active_cards\": [\n {\n \"last_4_digits\": \"XXXXXXXXXXXX6622\",\n \"identifier\": \"surec804a8ed60c747cb8839\",\n \"card_type\": \"Visa\",\n \"register\": \"2023-07-26 08:00:19\"\n },\n {\n \"last_4_digits\": \"XXXXXXXXXXXX1234\",\n \"identifier\": \"surec804a8ed60c747cb8843\",\n \"card_type\": \"MasterCard\",\n \"register\": \"2023-01-01 12:00:00\"\n }\n ],\n \"transactions\": [\n {\n \"created_at\": \"2023-09-30 19:58:35\",\n \"amount\": 10000,\n \"transaction\": 204444,\n \"authorization_code\": \"1234\",\n \"order\": \"001\",\n \"description\": \"descripcion\",\n \"status\": \"success\"\n }\n ],\n \"logs\": {\n \"status\": [\n {\n \"change_date\": \"2021-02-17 16:11:53\",\n \"initial_status\": \"register\",\n \"final_status\": \"active\"\n }\n ]\n }\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/sususcription/{identificadorSuscripcion}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Eliminar suscripción", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription/:identificadorsuscripcion", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription", ":identificadorsuscripcion" ], "variable": [ { "key": "identificadorsuscripcion", "value": "", "description": "identificadorSuscripcion" } ] }, "description": "Este método permite la eliminación de una suscripción asociada a un ID de suscripción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription/:identificadorsuscripcion", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription", ":identificadorsuscripcion" ], "variable": [ { "key": "identificadorsuscripcion", "value": "", "description": "identificadorSuscripcion" } ] }, "description": "Este método permite la eliminación de una suscripción asociada a un ID de suscripción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"sucaab7865dceaff49d8b3\",\n \"status\": \"success\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/sususcription/{identificadorSuscripcion}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Afiliar tarjeta", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suinscriptionscards", "host": [ "{{url_api}}" ], "path": [ "api", "suinscriptionscards" ] }, "description": "Este método permite la Inserción de los datos de una tarjeta para suscripción.\n\n**Improtante**\n\nEn caso de necesitar de la renovacion de tarjeta de su cliente, el método le permitira agregar una nueva tarjeta a la suscripcion.\n\n**¡Inmediatamente a la actualización de la tarjeta asociada a la suscripción, el sistema podrá realizar los cargos atrasados correspondientes según configuración del plan suscrito!**,\nEs decir, si la suscripción se encuentra en estatus suspendido por máximos intentos de cobros realizados, y el cliente registra una nueva tarjeta, el sistema podrá revisar los pagos pendientes, hacer el cargo correspondiente, y activar automáticamente la suscripción\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"sucaab7865dceaff49d8b3\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suinscriptionscards", "host": [ "{{url_api}}" ], "path": [ "api", "suinscriptionscards" ] }, "description": "Este método permite la Inserción de los datos de una tarjeta para suscripción.\n\n**Improtante**\n\nEn caso de necesitar de la renovacion de tarjeta de su cliente, el método le permitira agregar una nueva tarjeta a la suscripcion.\n\n**¡Inmediatamente a la actualización de la tarjeta asociada a la suscripción, el sistema podrá realizar los cargos atrasados correspondientes según configuración del plan suscrito!**,\nEs decir, si la suscripción se encuentra en estatus suspendido por máximos intentos de cobros realizados, y el cliente registra una nueva tarjeta, el sistema podrá revisar los pagos pendientes, hacer el cargo correspondiente, y activar automáticamente la suscripción\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"sucaab7865dceaff49d8b3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"id\": \"sucaab7865dceaff49d8b3\",\n \"url\": \"https://BASE_URL/gateway/registrosuscripcion?plan=true&token=246&validacion=d6b32\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suinscriptionscards\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Eliminar tarjeta", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suscriptionsdeletecards", "host": [ "{{url_api}}" ], "path": [ "api", "suscriptionsdeletecards" ] }, "description": "Este método permite eliminar una tarjeta asociada a la suscripción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"surec804a8ed60c0a8cb8839\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suscriptionsdeletecards", "host": [ "{{url_api}}" ], "path": [ "api", "suscriptionsdeletecards" ] }, "description": "Este método permite eliminar una tarjeta asociada a la suscripción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"surec804a8ed60c0a8cb8839\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Delete\",\n \"card\": \"surec804a8ed60c0a8cb8839\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suscriptionsdeletecards\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener plan", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suplan/:identificadorplan", "host": [ "{{url_api}}" ], "path": [ "api", "suplan", ":identificadorplan" ], "variable": [ { "key": "identificadorplan", "value": "", "description": "identificadorPlan" } ] }, "description": "Este método permite obtener el detalle de un plan.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suplan/:identificadorplan", "host": [ "{{url_api}}" ], "path": [ "api", "suplan", ":identificadorplan" ], "variable": [ { "key": "identificadorplan", "value": "", "description": "identificadorPlan" } ] }, "description": "Este método permite obtener el detalle de un plan.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"plans\": {\n \"id\": \"pl4293e97a87195bb9edcd\",\n \"status\": \"active\",\n \"name\": \"Test plan\",\n \"code\": \"001\",\n \"description\": \"Test Plan\",\n \"url_notify_payment\": \"\",\n \"url_notify_suscription\": \"\",\n \"total_suscription\": 0,\n \"total_suscription_active\": 0\n }\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suplan/{identificadorPlan}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener planes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suplan/plans", "host": [ "{{url_api}}" ], "path": [ "api", "suplan", "plans" ] }, "description": "Este método permite obtener el detalle de todos los planes.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suplan/plans", "host": [ "{{url_api}}" ], "path": [ "api", "suplan", "plans" ] }, "description": "Este método permite obtener el detalle de todos los planes.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"plans\": [\n {\n \"id\": \"pl4293e97a87195bb9edcd\",\n \"status\": \"active\",\n \"name\": \"Test plan\",\n \"code\": \"001\",\n \"description\": \"Test Plan\",\n \"url_notify_payment\": \"\",\n \"url_notify_suscription\": \"\",\n \"total_suscription\": 0,\n \"total_suscription_active\": 0\n }\n ]\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suplan/plans\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] } ], "description": "Permite la vinculación de un plan a un cliente, para posteriormente realizar cargos recurrentes automáticamente, según se defina en cada plan." }, { "name": "Suscripción de consumo", "item": [ { "name": "Crear cliente", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient", "host": [ "{{url_api}}" ], "path": [ "api", "suclient" ] }, "description": "Este método permite la creación de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"name\": \"John Doe\",\n \"rut\": \"11111111\",\n \"phone\": \"923122312\",\n \"address\": \"Moneda 101\",\n \"country\": \"Chile\",\n \"region\": \"Metropolitana\",\n \"city\": \"Santiago\",\n \"postal_code\": \"850000\",\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suclient", "host": [ "{{url_api}}" ], "path": [ "api", "suclient" ] }, "description": "Este método permite la creación de un cliente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"name\": \"John Doe\",\n \"rut\": \"11111111\",\n \"phone\": \"923122312\",\n \"address\": \"Moneda 101\",\n \"country\": \"Chile\",\n \"region\": \"Metropolitana\",\n \"city\": \"Santiago\",\n \"postal_code\": \"850000\",\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"active\",\n \"id\": \"cl0be4c8e623c167bc8b777\",\n \"rut\": \"11111111\",\n \"name\": \"John Doe\",\n \"phone\": \"923122312\",\n \"email\": \"johndoe@example.com\",\n \"address\": \"Moneda 101\",\n \"country\": \"Chile\",\n \"region\": \"Metropolitana\",\n \"city\": \"Santiago\",\n \"postal_code\": \"850000\",\n \"created_at\": \"2023-09-29\",\n \"update_at\": null,\n \"subcriptions\": null,\n \"additional_parameters\": {\n \"parameter_1\": \"example\",\n \"parameter_2\": \"example\"\n }\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suclient/\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Crear plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suplan", "host": [ "{{url_api}}" ], "path": [ "api", "suplan" ] }, "description": "Este método permite la Inserción de los datos para la creación de un plan.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Test plan\",\n \"description\": \"Test Plan\",\n \"url_notify_suscription\": \"https://youwebsite.com/urlnotifysuscription\",\n \"url_notify_payment\": \"https://youwebsite.com/urlnotifypayment\",\n \"url_success_payment\": \"https://youwebsite.com/urlsuccesspayment\",\n \"url_failed_payment\": \"https://youwebsite.com/urlfailedpayment\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suplan", "host": [ "{{url_api}}" ], "path": [ "api", "suplan" ] }, "description": "Este método permite la Inserción de los datos para la creación de un plan.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Test plan\",\n \"description\": \"Test Plan\",\n \"url_notify_suscription\": \"https://youwebsite.com/urlnotifysuscription\",\n \"url_notify_payment\": \"https://youwebsite.com/urlnotifypayment\",\n \"url_success_payment\": \"https://youwebsite.com/urlsuccesspayment\",\n \"url_failed_payment\": \"https://youwebsite.com/urlfailedpayment\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"id\": \"pl4293e97a87195bb9edcd\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suplan/\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Crear suscripción", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription" ] }, "description": "Este método permite al usuario de una cuenta payku crear una suscripción a un plan de suscripción de monto fijo, suscripción de plan de consumo y suscripción de monto variable a uno de sus clientes, para este ultimo tipo de suscripción es necesario enviar el monto que sera cobrado en la suscripción, es importante destacar que al realizar esta solicitud por primera vez se realizará un cobro de $50 que permite comprobar que la tarjeta se encuentra activa y es válida, en el caso de un plan de suscripción fijo el cobro del servicio será automático a partir del mes siguiente de la fecha de suscripción y en el caso que la suscripción sea a un plan de consumo será necesario utilizar el endpoint api/sutransaction para generar la transacción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"plan\": \"pl9697fb170834ad42dd00\",\n \"client\": \"cl9b1e1dd988694f30fa30\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sususcription", "host": [ "{{url_api}}" ], "path": [ "api", "sususcription" ] }, "description": "Este método permite al usuario de una cuenta payku crear una suscripción a un plan de suscripción de monto fijo, suscripción de plan de consumo y suscripción de monto variable a uno de sus clientes, para este ultimo tipo de suscripción es necesario enviar el monto que sera cobrado en la suscripción, es importante destacar que al realizar esta solicitud por primera vez se realizará un cobro de $50 que permite comprobar que la tarjeta se encuentra activa y es válida, en el caso de un plan de suscripción fijo el cobro del servicio será automático a partir del mes siguiente de la fecha de suscripción y en el caso que la suscripción sea a un plan de consumo será necesario utilizar el endpoint api/sutransaction para generar la transacción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"plan\": \"pl9697fb170834ad42dd00\",\n \"client\": \"cl9b1e1dd988694f30fa30\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"register\",\n \"id\": \"sucaab7865dceaff49d8b3\",\n \"url\": \"http://BASE_URL/gateway/registrosuscripcion?tipoplan=2&plan=true&token=219&validacion=e6c50ba0e0\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/sususcription/\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Crear transacción", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sutransaction", "host": [ "{{url_api}}" ], "path": [ "api", "sutransaction" ] }, "description": "Este método permite al usuario de una cuenta payku crear una transacción única a uno de sus clientes que encuentre suscrito a un plan de consumo.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"sucaab7865dceaff49d8b3\",\n \"amount\": \"10000\",\n \"order\": \"001\",\n \"description\": \"Descripción\",\n \"marketplace\": \"ma0690b6451a7043d5\",\n \"card\": \"surea041d8a4413949425fec\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/sutransaction", "host": [ "{{url_api}}" ], "path": [ "api", "sutransaction" ] }, "description": "Este método permite al usuario de una cuenta payku crear una transacción única a uno de sus clientes que encuentre suscrito a un plan de consumo.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"sucaab7865dceaff49d8b3\",\n \"amount\": \"10000\",\n \"order\": \"001\",\n \"description\": \"Descripción\",\n \"marketplace\": \"ma0690b6451a7043d5\",\n \"card\": \"surea041d8a4413949425fec\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"order\": \"001\",\n \"amount\": \"10000\",\n \"transaction_id\": \"204444\",\n \"verification_key\": \"025dcad37e071daa8bfc2df35189009db65692a4ff766856108be1675e870839\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/sutransaction/\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Eliminar tarjeta", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suscriptionsdeletecards", "host": [ "{{url_api}}" ], "path": [ "api", "suscriptionsdeletecards" ] }, "description": "Este método permite eliminar una tarjeta asociada a la suscripción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"surec804a8ed60c0a8cb8839\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/suscriptionsdeletecards", "host": [ "{{url_api}}" ], "path": [ "api", "suscriptionsdeletecards" ] }, "description": "Este método permite eliminar una tarjeta asociada a la suscripción.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"suscription\": \"surec804a8ed60c0a8cb8839\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Delete\",\n \"card\": \"surec804a8ed60c0a8cb8839\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/suscriptionsdeletecards/\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] } ], "description": "Es el conjunto de métodos que permitirán a nuestros usuarios la creación de clientes, planes, suscripciones y realizar transacciones de planes de consumo.\n\nEl principal uso de estos métodos es para realizar cargos únicos a un cliente por un servicio o producto, como por el ejemplo la contratación de un servicio de delivery de algún producto o la compra de un producto en particular.\n\nSi se desea que el cliente vaya directo a la pasarela de pago de webpay es necesario enviar a través de parámetros en la url, en caso de una suscripción con los parámetros básicos como son nombre, apellido, email y teléfono, la url tendría la siguiente forma:\nhttps://BASE_URL/suscripcion/index?idplan=607&verif=b4280f5e&nombre=vicente&apellido=borjas&email=example@ example.com&telefono=986523565&direct_full=true\n\nSi se desean agregar otros parámetros estos deben ser concatenados a través de & continuando con la estructura antes mostrada." }, { "name": "Wallet", "item": [ { "name": "Realizar pagos a terceros desde mi wallet", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet/payout", "host": [ "{{url_api}}" ], "path": [ "api", "wallet", "payout" ] }, "description": "Este método permite crear una orden de pago a un tercero utilizando los fondos de tu billetera virtual **payku**.\n\n**Nota:** Para fines de prueba (Solo ambiente desarrollo), los montos específicos se procesarán automáticamente:\n \n• Montos 1000, 2000, 3000: Se marcarán como **aprobados** automáticamente.\n \n• Montos 1500, 2500, 3500: Se marcarán como **rechazados** automáticamente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"phone\": \"923122312\",\n \"subject\": \"payOut description\",\n \"currency\": \"CLP\",\n \"order\": \"98745\",\n \"amount\": 25000,\n \"accountbank_name\": \"Jhon Doe\",\n \"accountbank_rut\": \"111111111\",\n \"accountbank_sbif\": \"0001\",\n \"accountbank_type\": \"1\",\n \"accountbank_num\": \"12312312312\",\n \"url_notify\": \"https://www.youwebsite.com/urlnotify?orderClient=98745\",\n \"additional_parameters\": {\n \"parameter_1\": \"keyValue\",\n \"parameter_2\": \"keyValue\",\n \"order_ext\": \"fff-777\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet/payout", "host": [ "{{url_api}}" ], "path": [ "api", "wallet", "payout" ] }, "description": "Este método permite crear una orden de pago a un tercero utilizando los fondos de tu billetera virtual **payku**.\n\n**Nota:** Para fines de prueba (Solo ambiente desarrollo), los montos específicos se procesarán automáticamente:\n \n• Montos 1000, 2000, 3000: Se marcarán como **aprobados** automáticamente.\n \n• Montos 1500, 2500, 3500: Se marcarán como **rechazados** automáticamente.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"email\": \"johndoe@example.com\",\n \"phone\": \"923122312\",\n \"subject\": \"payOut description\",\n \"currency\": \"CLP\",\n \"order\": \"98745\",\n \"amount\": 25000,\n \"accountbank_name\": \"Jhon Doe\",\n \"accountbank_rut\": \"111111111\",\n \"accountbank_sbif\": \"0001\",\n \"accountbank_type\": \"1\",\n \"accountbank_num\": \"12312312312\",\n \"url_notify\": \"https://www.youwebsite.com/urlnotify?orderClient=98745\",\n \"additional_parameters\": {\n \"parameter_1\": \"keyValue\",\n \"parameter_2\": \"keyValue\",\n \"order_ext\": \"fff-777\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"identifier_wallet\": \"wab5f7232dafff18f9\",\n \"identifier_payout\": \"mor33e36b01e8a11b9ee\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/wallet/payout\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Retirar dinero de mi wallet", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet/withdraw", "host": [ "{{url_api}}" ], "path": [ "api", "wallet", "withdraw" ] }, "description": "Este método permite crear una liquidación a la cuenta bancaria del comercio utilizando los fondos de tu billetera virtual **payku**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"subject\": \"payment description\",\n \"currency\": \"CLP\",\n \"order\": \"98745\",\n \"amount\": 25000\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet/withdraw", "host": [ "{{url_api}}" ], "path": [ "api", "wallet", "withdraw" ] }, "description": "Este método permite crear una liquidación a la cuenta bancaria del comercio utilizando los fondos de tu billetera virtual **payku**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición.", "body": { "mode": "raw", "raw": "{\n \"subject\": \"payment description\",\n \"currency\": \"CLP\",\n \"order\": \"98745\",\n \"amount\": 25000\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"identifier_wallet\": \"wab5f7232dafff18f9\"\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/wallet/withdraw\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener saldo", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet", "host": [ "{{url_api}}" ], "path": [ "api", "wallet" ] }, "description": "Este método permite obtener el saldo de tu billetera virtual **payku**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet", "host": [ "{{url_api}}" ], "path": [ "api", "wallet" ] }, "description": "Este método permite obtener el saldo de tu billetera virtual **payku**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"current_id\": \"wa8a6171ab83323c37\",\n \"amount_available\": 1766,\n \"currency\": \"CLP\",\n \"filter\": {\n \"page\": 1,\n \"per_page\": 1000,\n \"currency\": \"CLP\",\n \"id\": \"wa8a6171ab83323c37\"\n },\n \"wallet_movements\": [\n {\n \"id\": \"wa8a6171ab83323c37\",\n \"order\": \"tme5\",\n \"subject\": \"tme5 asunto\",\n \"created_at\": \"2023-06-09 20:07:02\",\n \"income_expense\": \"expense\",\n \"status\": \"current\",\n \"amount\": \"3680\",\n \"actual_amount\": \"1766\",\n \"origin_liquidation\": null,\n \"currency\": \"CLP\",\n \"payout\": {\n \"id\": \"war3999847529816f2\",\n \"phone\": \"111111111\",\n \"email\": \"test@test.com\",\n \"subject\": \"subject order\",\n \"amount\": \"3680\",\n \"accountbank_rut\": \"111111111\",\n \"accountbank_name\": \"test\",\n \"accountbank_type\": 1,\n \"accountbank_num\": 123123123,\n \"accountbank_sbif\": \"0001\",\n \"status\": \"pending\",\n \"update_at\": \"2023-06-09 21:10:46\"\n }\n }\n ]\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/wallet\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener movimientos", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet/list", "host": [ "{{url_api}}" ], "path": [ "api", "wallet", "list" ] }, "description": "Este método permite obtener los movimientos de su billetera virtual **payku**, este método permite una paginación con un máximo de 4000 registros por página, además, posee los siguientes filtros:\n\nPara la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página Como por ejemplo: **api/wallet/list?page=1&per_page=100**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet/list", "host": [ "{{url_api}}" ], "path": [ "api", "wallet", "list" ] }, "description": "Este método permite obtener los movimientos de su billetera virtual **payku**, este método permite una paginación con un máximo de 4000 registros por página, además, posee los siguientes filtros:\n\nPara la paginación es necesario agregar al final del endpoint lo siguiente ?page=1&per_page=100 siendo el primer parámetro el número de la página y el segundo el número de registros por página Como por ejemplo: **api/wallet/list?page=1&per_page=100**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"current_id\": \"wa8a6171ab83323c37\",\n \"amount_available\": 1766,\n \"currency\": \"CLP\",\n \"filter\": {\n \"page\": 1,\n \"per_page\": 1000,\n \"currency\": \"CLP\",\n \"id\": \"wa8a6171ab83323c37\"\n },\n \"wallet_movements\": [\n {\n \"id\": \"wa8a6171ab83323c37\",\n \"order\": \"tme5\",\n \"subject\": \"tme5 asunto\",\n \"created_at\": \"2023-06-09 20:07:02\",\n \"income_expense\": \"expense\",\n \"status\": \"current\",\n \"amount\": \"3680\",\n \"actual_amount\": \"1766\",\n \"origin_liquidation\": null,\n \"currency\": \"CLP\",\n \"payout\": {\n \"id\": \"war3999847529816f2\",\n \"phone\": \"111111111\",\n \"email\": \"test@test.com\",\n \"subject\": \"subject order\",\n \"amount\": \"3680\",\n \"accountbank_rut\": \"111111111\",\n \"accountbank_name\": \"test\",\n \"accountbank_type\": 1,\n \"accountbank_num\": 123123123,\n \"accountbank_sbif\": \"0001\",\n \"status\": \"pending\",\n \"update_at\": \"2023-06-09 21:10:46\"\n }\n }\n ]\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/wallet/list\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener movimiento", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet/:identificadorwallet", "host": [ "{{url_api}}" ], "path": [ "api", "wallet", ":identificadorwallet" ], "variable": [ { "key": "identificadorwallet", "value": "", "description": "identificadorWallet" } ] }, "description": "Este método permite obtener un movimiento de su billetera virtual **payku** mediante un identificador:\n\nPara realizar la consulta es necesario agregar al final del endpoint lo siguiente /{identificadorWallet} como por ejemplo: **api/wallet/wa24bg36767**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/wallet/:identificadorwallet", "host": [ "{{url_api}}" ], "path": [ "api", "wallet", ":identificadorwallet" ], "variable": [ { "key": "identificadorwallet", "value": "", "description": "identificadorWallet" } ] }, "description": "Este método permite obtener un movimiento de su billetera virtual **payku** mediante un identificador:\n\nPara realizar la consulta es necesario agregar al final del endpoint lo siguiente /{identificadorWallet} como por ejemplo: **api/wallet/wa24bg36767**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"current_id\": \"wa8a6171ab83323c37\",\n \"amount_available\": 1766,\n \"currency\": \"CLP\",\n \"filter\": {\n \"page\": 1,\n \"per_page\": 1000,\n \"currency\": \"CLP\",\n \"id\": \"wa8a6171ab83323c37\"\n },\n \"wallet_movements\": [\n {\n \"id\": \"wa8a6171ab83323c37\",\n \"order\": \"tme5\",\n \"subject\": \"tme5 asunto\",\n \"created_at\": \"2023-06-09 20:07:02\",\n \"income_expense\": \"expense\",\n \"status\": \"current\",\n \"amount\": \"3680\",\n \"actual_amount\": \"1766\",\n \"origin_liquidation\": null,\n \"currency\": \"CLP\",\n \"payout\": {\n \"id\": \"war3999847529816f2\",\n \"phone\": \"111111111\",\n \"email\": \"test@test.com\",\n \"subject\": \"subject order\",\n \"amount\": \"3680\",\n \"accountbank_rut\": \"111111111\",\n \"accountbank_name\": \"test\",\n \"accountbank_type\": 1,\n \"accountbank_num\": 123123123,\n \"accountbank_sbif\": \"0001\",\n \"status\": \"pending\",\n \"update_at\": \"2023-06-09 21:10:46\"\n }\n }\n ]\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/wallet/{identificadorWallet}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener payout", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/payout/:identificadorpayout", "host": [ "{{url_api}}" ], "path": [ "api", "payout", ":identificadorpayout" ], "variable": [ { "key": "identificadorpayout", "value": "", "description": "identificadorPayout" } ] }, "description": "Este método permite obtener un movimiento de pagos a terceros de su billetera virtual **payku** mediante un identificador:\n\nPara realizar la consulta es necesario agregar al final del endpoint lo siguiente /{identificadorPayout} como por ejemplo: **api/payout/wa24bg36767**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/payout/:identificadorpayout", "host": [ "{{url_api}}" ], "path": [ "api", "payout", ":identificadorpayout" ], "variable": [ { "key": "identificadorpayout", "value": "", "description": "identificadorPayout" } ] }, "description": "Este método permite obtener un movimiento de pagos a terceros de su billetera virtual **payku** mediante un identificador:\n\nPara realizar la consulta es necesario agregar al final del endpoint lo siguiente /{identificadorPayout} como por ejemplo: **api/payout/wa24bg36767**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payout\": {\n \"id\": \"war3999847529816f2\",\n \"phone\": \"111111111\",\n \"email\": \"test@test.com\",\n \"subject\": \"subject order\",\n \"amount\": \"3680\",\n \"accountbank_rut\": \"111111111\",\n \"accountbank_name\": \"test\",\n \"accountbank_type\": 1,\n \"accountbank_num\": 123123123,\n \"accountbank_sbif\": \"0001\",\n \"status\": \"pending\",\n \"update_at\": \"2023-06-09 21:10:46\",\n \"origin_wallet\": \"wa1933f37cdaf7d1c6\"\n }\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/payout/{identificadorPayout}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] }, { "name": "Obtener payout V3", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/payoutv3/:identificadorpayout", "host": [ "{{url_api}}" ], "path": [ "api", "payoutv3", ":identificadorpayout" ], "variable": [ { "key": "identificadorpayout", "value": "", "description": "identificadorPayout" } ] }, "description": "Este método permite obtener un movimiento de pagos a terceros de su billetera virtual **payku** mediante un identificador:\n\nPara realizar la consulta es necesario agregar al final del endpoint lo siguiente /{identificadorPayout} como por ejemplo: **api/payoutv3/mor33e36b01e8a11b9ee**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Sign", "value": "{{firma}}" } ], "url": { "raw": "{{url_api}}/api/payoutv3/:identificadorpayout", "host": [ "{{url_api}}" ], "path": [ "api", "payoutv3", ":identificadorpayout" ], "variable": [ { "key": "identificadorpayout", "value": "", "description": "identificadorPayout" } ] }, "description": "Este método permite obtener un movimiento de pagos a terceros de su billetera virtual **payku** mediante un identificador:\n\nPara realizar la consulta es necesario agregar al final del endpoint lo siguiente /{identificadorPayout} como por ejemplo: **api/payoutv3/mor33e36b01e8a11b9ee**.\n\n---\nEsta operación requiere la firma `Sign` (HMAC-SHA256 con tu token privado). El script de pre-request la calcula automáticamente a partir del cuerpo de la petición." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payout\": {\n \"id\": \"war3999847529816f2\",\n \"phone\": \"111111111\",\n \"email\": \"test@test.com\",\n \"subject\": \"subject order\",\n \"amount\": \"3680\",\n \"accountbank_rut\": \"111111111\",\n \"accountbank_name\": \"test\",\n \"accountbank_type\": 1,\n \"accountbank_num\": 123123123,\n \"accountbank_sbif\": \"0001\",\n \"status\": \"pending\",\n \"update_at\": \"2023-06-09 21:10:46\",\n \"origin_wallet\": \"wa1933f37cdaf7d1c6\",\n \"reason_rejection\": \" Error CCA 51. Cuenta Beneficiario no Existe, error_creditor_account_not_found\"\n }\n}" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Computes the `Sign` header documented in the Firma / Signature section.", "const requestPath = encodeURIComponent(\"/api/payoutv3/{identificadorPayout}\");", "let body = {};", "try { body = JSON.parse(pm.request.body ? pm.request.body.raw : \"{}\") || {}; } catch (e) { body = {}; }", "", "const pairs = Object.keys(body).sort()", " .filter((key) => body[key] !== null && typeof body[key] !== \"object\")", " .map((key) => encodeURIComponent(key) + \"=\" + encodeURIComponent(body[key]).replace(/%20/g, \"+\"));", "", "const concat = [requestPath].concat(pairs).join(\"&\");", "const sign = CryptoJS.HmacSHA256(concat, pm.environment.get(\"token_priv\")).toString();", "pm.environment.set(\"firma\", sign);" ] } } ] } ], "description": "Permite generar transacciones bancarias desde tu billetera virtual **payku**." }, { "name": "Conciliación", "item": [ { "name": "Obtener conciliaciones.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/conciliation", "host": [ "{{url_api}}" ], "path": [ "api", "conciliation" ] }, "description": "Permite obtener las conciliaciones bancaria del dinero generado por su cuenta y depositado por **payku** en los días correspondiente a sus pago.", "body": { "mode": "raw", "raw": "{\n \"date_init\": \"2023-10-20\",\n \"date_end\": \"2023-10-21\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/conciliation", "host": [ "{{url_api}}" ], "path": [ "api", "conciliation" ] }, "description": "Permite obtener las conciliaciones bancaria del dinero generado por su cuenta y depositado por **payku** en los días correspondiente a sus pago.", "body": { "mode": "raw", "raw": "{\n \"date_init\": \"2023-10-20\",\n \"date_end\": \"2023-10-21\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"conciliation\": [\n {\n \"id\": \"107999\",\n \"created_at\": \"2019-10-25 14:10:03\",\n \"amount_available\": 98745,\n \"amount_deposit\": 0,\n \"status\": \"pending\",\n \"destiny\": \"wallet\",\n \"currency\": \"CLP\",\n \"wallet\": null,\n \"transaction\": [\n {\n \"transaction_id\": \"rsyt68j4dhg6k8j54ut698dt6hj84\",\n \"payment_key\": \"pra934939d607922f9e\",\n \"order\": \"6544\",\n \"start\": \"2023-12-16 15:10:33\",\n \"end\": \"2023-12-16 15:10:36\",\n \"deposit_date\": \"2023-10-05\",\n \"amount\": 250000,\n \"fee\": 15000,\n \"amount_deposit\": 235000,\n \"media\": \"Webpay\"\n }\n ]\n }\n ]\n}" } ] } ], "description": "Permite obtener las conciliaciones en **payku**." }, { "name": "Bancos", "item": [ { "name": "Obtener lista de bancos por el tipo de moneda", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/banks?currency=clp", "host": [ "{{url_api}}" ], "path": [ "api", "banks" ], "query": [ { "key": "currency", "value": "clp" } ] }, "description": "Este método permite obtener una lista de los bancos asociados filtrados por la moneda.\nPara filtrar por la moneda, hay que agregar el query params currency con el valor de la moneda." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/banks?currency=clp", "host": [ "{{url_api}}" ], "path": [ "api", "banks" ], "query": [ { "key": "currency", "value": "clp" } ] }, "description": "Este método permite obtener una lista de los bancos asociados filtrados por la moneda.\nPara filtrar por la moneda, hay que agregar el query params currency con el valor de la moneda." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"banks\": [\n {\n \"code\": \"0001\",\n \"name\": \"Banco de Chile\",\n \"currency\": \"CLP\"\n },\n {\n \"code\": \"0012\",\n \"name\": \"Banco Estado\",\n \"currency\": \"CLP\"\n }\n ]\n}" } ] } ], "description": "Permite ver la lista de los bancos asociados." }, { "name": "Métodos de pago", "item": [ { "name": "Obtener lista de los métodos de pago en payku", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/paymentmethods", "host": [ "{{url_api}}" ], "path": [ "api", "paymentmethods" ] }, "description": "Este método permite obtener una lista de los métodos de pago en payku." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/paymentmethods", "host": [ "{{url_api}}" ], "path": [ "api", "paymentmethods" ] }, "description": "Este método permite obtener una lista de los métodos de pago en payku." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"payment_methods\": [\n {\n \"currency\": \"CLP\",\n \"payment\": 1,\n \"name\": \"Webpay\",\n \"description\": \"Visa, Mastercard, Magna, American, Diners y Redcompra.\"\n }\n ]\n}" } ] }, { "name": "Obtener lista de métodos de pago por el tipo de moneda", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/paymentmethods?currency=clp", "host": [ "{{url_api}}" ], "path": [ "api", "paymentmethods" ], "query": [ { "key": "currency", "value": "clp" } ] }, "description": "Este método permite obtener una lista de los métodos de pago en payku.\nPara filtrar por la moneda, hay que agregar el query params currency con el valor de la moneda." }, "response": [ { "name": "200 — OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url_api}}/api/paymentmethods?currency=clp", "host": [ "{{url_api}}" ], "path": [ "api", "paymentmethods" ], "query": [ { "key": "currency", "value": "clp" } ] }, "description": "Este método permite obtener una lista de los métodos de pago en payku.\nPara filtrar por la moneda, hay que agregar el query params currency con el valor de la moneda." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"payment_methods\": [\n {\n \"currency\": \"CLP\",\n \"payment\": 1,\n \"name\": \"Webpay\",\n \"description\": \"Visa, Mastercard, Magna, American, Diners y Redcompra.\"\n },\n {\n \"currency\": \"CLP\",\n \"payment\": 9,\n \"name\": \"MACH\",\n \"description\": \"Paga en comercios online internacionales y nacionales\"\n }\n ]\n}" } ] } ], "description": "Permite ver la lista de los métodos de pago utilizados por payku." } ], "variable": [ { "key": "url_api", "value": "https://des.payku.cl", "type": "string" } ] }