# API Reference El API de ZRU utiliza métodos HTTP y una estructura RESTful de endpoint. - La autenticación del API se realiza vía Header Authorization. - Todas las peticiones se deben realizar en formato JSON, y las respuestas del API son en dicho formato. Version: 1.0 ## Servers v1 ``` https://api.zrupay.com/v1 ``` ## Security ### AppKeys El header Authorization debe tener como valor AppKeys PUBLIC:SECRET. Los valores PUBLIC y SECRET se obtienen accediendo al panel de ZRU Type: apiKey In: header Name: Authorization ## Download OpenAPI description [API Reference](https://docs.zrupay.com/_bundle/apis/index.yaml) ## Transaction ### Listar Transacciones - [GET /transaction/](https://docs.zrupay.com/apis/transaction/get-transactions.md): Devuelve todas las transacciones creadas en el entorno. ### Crear Transacción - [POST /transaction/](https://docs.zrupay.com/apis/transaction/post-transaction.md): Crea una transacción en el entorno. ### Obtener Transacción - [GET /transaction/{transaction-id}/](https://docs.zrupay.com/apis/transaction/get-transaction.md): Devuelve la transacción solicitada. ## Subscription ### Listar Suscripciones - [GET /subscription/](https://docs.zrupay.com/apis/subscription/get-subscriptions.md): Devuelve todas las suscripciones creadas en el entorno. ### Crear Suscripción - [POST /subscription/](https://docs.zrupay.com/apis/subscription/post-subscription.md): Crea una suscripción en el entorno. ### Obtener Suscripción - [GET /subscription/{subscription-id}/](https://docs.zrupay.com/apis/subscription/get-subscription.md): Devuelve la suscripción solicitada. ### Iniciar Suscripción - [POST /subscription/{subscription-id}/start/](https://docs.zrupay.com/apis/subscription/post-subscription-start.md): Inicia la suscripción solicitada, debe estar en espera. ### Pausar Suscripción - [POST /subscription/{subscription-id}/pause/](https://docs.zrupay.com/apis/subscription/post-subscription-pause.md): Pausa la suscripción solicitada, debe estar activa. ### Activar Suscripción - [POST /subscription/{subscription-id}/active/](https://docs.zrupay.com/apis/subscription/post-subscription-active.md): Activa la suscripción solicitada, debe estar en pausa. ### Parar Suscripción - [POST /subscription/{subscription-id}/stop/](https://docs.zrupay.com/apis/subscription/post-subscription-stop.md): Para la suscripción solicitada, después de ejecutar esta acción la suscripción no podrá ser reactivada ni se realizarán cobros. ## Authorization ### Listar Autorizaciones - [GET /authorization/](https://docs.zrupay.com/apis/authorization/get-authorizations.md): Devuelve todas las autorizaciones creadas en el entorno. ### Crear Autorización - [POST /authorization/](https://docs.zrupay.com/apis/authorization/post-authorization.md): Crea una autorización en el entorno. ### Obtener Autorización - [GET /authorization/{authorization-id}/](https://docs.zrupay.com/apis/authorization/get-authorization.md): Devuelve la autorización solicitada. ### Cobrar una Autorización - [POST /authorization/{authorization-id}/charge/](https://docs.zrupay.com/apis/authorization/post-authorization-charge.md): Realiza un cobro utilizando el método de pago autorizado. ### Eliminar una Autorización - [POST /authorization/{authorization-id}/remove/](https://docs.zrupay.com/apis/authorization/post-authorization-remove.md): Elimina una autorización, después de realizar esta acción no se podrá utilizar de nuevo. ## Sale ### Listar Pagos - [GET /sale/](https://docs.zrupay.com/apis/sale/get-sales.md): Devuelve todos los pagos creados en el entorno. ### Obtener Pago - [GET /sale/{sale-id}/](https://docs.zrupay.com/apis/sale/get-sale.md): Devuelve el pago solicitado. ### Capturar Pago - [POST /sale/{sale-id}/capture/](https://docs.zrupay.com/apis/sale/post-sale-capture.md): Captura la parte del pago en espera, total o parcialmente. ### Devolver Pago - [POST /sale/{sale-id}/refund/](https://docs.zrupay.com/apis/sale/post-sale-refund.md): Devuelve la parte del pago capturada, total o parcialmente. ### Liberar Pago - [POST /sale/{sale-id}/void/](https://docs.zrupay.com/apis/sale/post-sale-void.md): Libera la parte del pago en espera, total o parcialmente. ## Product ### Listar Productos - [GET /product/](https://docs.zrupay.com/apis/product/get-products.md): Devuelve todos los productos creados en el entorno. ### Crear Producto - [POST /product/](https://docs.zrupay.com/apis/product/post-product.md): Crea un producto en el entorno. ### Obtener Producto - [GET /product/{product-id}/](https://docs.zrupay.com/apis/product/get-product.md): Devuelve el producto solicitado. ### Editar Producto - [PATCH /product/{product-id}/](https://docs.zrupay.com/apis/product/patch-product.md): Edita el producto solicitado. ### Eliminar Producto - [DELETE /product/{product-id}/](https://docs.zrupay.com/apis/product/delete-product.md): Elimina el producto solicitado. ## Plan ### Listar Planes - [GET /plan/](https://docs.zrupay.com/apis/plan/get-plans.md): Devuelve todos los planes creados en el entorno. ### Crear Plan - [POST /plan/](https://docs.zrupay.com/apis/plan/post-plan.md): Crea un plan en el entorno. ### Obtener Plan - [GET /plan/{plan-id}/](https://docs.zrupay.com/apis/plan/get-plan.md): Devuelve el plan solicitado. ### Editar Plan - [PATCH /plan/{plan-id}/](https://docs.zrupay.com/apis/plan/patch-plan.md): Edita el plan solicitado. ### Eliminar Plan - [DELETE /plan/{plan-id}/](https://docs.zrupay.com/apis/plan/delete-plan.md): Elimina el plan solicitado. ## Tax ### Listar Impuestos - [GET /tax/](https://docs.zrupay.com/apis/tax/get-taxes.md): Devuelve todos los impuestos creados en el entorno. ### Crear Impuesto - [POST /tax/](https://docs.zrupay.com/apis/tax/post-tax.md): Crea un impuesto en el entorno. ### Obtener Impuesto - [GET /tax/{tax-id}/](https://docs.zrupay.com/apis/tax/get-tax.md): Devuelve el impuesto solicitado. ### Editar Impuesto - [PATCH /tax/{tax-id}/](https://docs.zrupay.com/apis/tax/patch-tax.md): Edita el impuesto solicitado. ### Eliminar Impuesto - [DELETE /tax/{tax-id}/](https://docs.zrupay.com/apis/tax/delete-tax.md): Elimina el impuesto solicitado. ## Shipping ### Listar Envíos - [GET /shipping/](https://docs.zrupay.com/apis/shipping/get-shippings.md): Devuelve todos los envíos creados en el entorno. ### Crear Envío - [POST /shipping/](https://docs.zrupay.com/apis/shipping/post-shipping.md): Crea un envío en el entorno. ### Obtener Envío - [GET /shipping/{shipping-id}/](https://docs.zrupay.com/apis/shipping/get-shipping.md): Devuelve el envío solicitado. ### Editar Envío - [PATCH /shipping/{shipping-id}/](https://docs.zrupay.com/apis/shipping/patch-shipping.md): Edita el envío solicitado. ### Eliminar Envío - [DELETE /shipping/{shipping-id}/](https://docs.zrupay.com/apis/shipping/delete-shipping.md): Elimina el envío solicitado. ## Coupon ### Listar Cupones - [GET /coupon/](https://docs.zrupay.com/apis/coupon/get-coupons.md): Devuelve todos los cupones creados en el entorno. ### Crear Cupón - [POST /coupon/](https://docs.zrupay.com/apis/coupon/post-coupon.md): Crea un cupón en el entorno. ### Obtener Cupón - [GET /coupon/{coupon-id}/](https://docs.zrupay.com/apis/coupon/get-coupon.md): Devuelve el cupón solicitado. ### Editar Cupón - [PATCH /coupon/{coupon-id}/](https://docs.zrupay.com/apis/coupon/patch-coupon.md): Edita el cupón solicitado. ### Eliminar Cupón - [DELETE /coupon/{coupon-id}/](https://docs.zrupay.com/apis/coupon/delete-coupon.md): Elimina el cupón solicitado. ## Client ### Listar Clientes - [GET /client/](https://docs.zrupay.com/apis/client/get-clients.md): Devuelve todos los clientes creados en el entorno. ### Crear Cliente - [POST /client/](https://docs.zrupay.com/apis/client/post-client.md): Crea un cliente en el entorno. ### Obtener Cliente - [GET /client/{client-id}/](https://docs.zrupay.com/apis/client/get-client.md): Devuelve el cliente solicitado. ### Editar Cliente - [PATCH /client/{client-id}/](https://docs.zrupay.com/apis/client/patch-client.md): Edita el cliente solicitado. ### Listar IBANs del Cliente - [GET /client/{client-id}/iban/](https://docs.zrupay.com/apis/client/get-client-ibans.md): Devuelve todos los IBANs del Cliente creados en el entorno. ### Crear IBAN del Cliente - [POST /client/{client-id}/iban/](https://docs.zrupay.com/apis/client/post-client-iban.md): Crea un IBAN del Cliente en el entorno. ### Obtener IBAN del Cliente - [GET /client/{client-id}/iban/{iban-id}/](https://docs.zrupay.com/apis/client/get-client-iban.md): Devuelve el IBAN solicitado del Cliente. ### Editar IBAN del Cliente - [PATCH /client/{client-id}/iban/{iban-id}/](https://docs.zrupay.com/apis/client/patch-client-iban.md): Editar el IBAN solicitado del Cliente. ### Listar Documentos del Cliente - [GET /client/{client-id}/document/](https://docs.zrupay.com/apis/client/get-client-documents.md): Devuelve todos los Documentos del Cliente creados en el entorno. ### Crear Documento del Cliente - [POST /client/{client-id}/document/](https://docs.zrupay.com/apis/client/post-client-document.md): Crea un Documento del Cliente en el entorno. ### Obtener Documento del Cliente - [GET /client/{client-id}/document/{document-id}/](https://docs.zrupay.com/apis/client/get-client-document.md): Devuelve el Documento solicitado del Cliente. ## Wallet ### Listar Cuentas de Pago - [GET /wallet/](https://docs.zrupay.com/apis/wallet/get-wallets.md): Devuelve todos las cuentas de pago creadas en el entorno. ### Crear Cuenta de Pago - [POST /wallet/](https://docs.zrupay.com/apis/wallet/post-wallet.md): Crea una cuenta de pago en el entorno. ### Obtener Cuenta de Pago - [GET /wallet/{wallet-id}/](https://docs.zrupay.com/apis/wallet/get-wallet.md): Devuelve la cuenta de pago solicitada. ### Editar Cuenta de Pago - [PATCH /wallet/{wallet-id}/](https://docs.zrupay.com/apis/wallet/patch-wallet.md): Edita la cuenta de pago solicitada. ### Listar Movimientos de la Cuenta de Pago - [GET /wallet/{wallet-id}/entry/](https://docs.zrupay.com/apis/wallet/get-wallet-entries.md): Devuelve todos los movimientos de la cuentas de pago existentes en el entorno. ### Obtener Movimiento de la Cuenta de Pago - [GET /wallet/{wallet-id}/entry/{entry-id}/](https://docs.zrupay.com/apis/wallet/get-wallet-entry.md): Devuelve el movimiento solicitado de la cuenta de pago. ## Transfer ### Listar Transferencias - [GET /transfer/](https://docs.zrupay.com/apis/transfer/get-transfers.md): Devuelve todas las transferencias creadas en el entorno. ### Crear Transferencia - [POST /transfer/](https://docs.zrupay.com/apis/transfer/post-transfer.md): Crea una transferencia en el entorno. ### Obtener Transferencia - [GET /transfer/{transfer-id}/](https://docs.zrupay.com/apis/transfer/get-transfer.md): Devuelve la transferencia solicitada. ## Gateway ### Listar Pasarelas de Pago - [GET /gateway/](https://docs.zrupay.com/apis/gateway/get-gateways.md): Devuelve todas las pasarelas de pago de el entorno. ### Obtener Pasarela de Pago - [GET /gateway/{gateway-id}/](https://docs.zrupay.com/apis/gateway/get-gateway.md): Devuelve la pasarela de pago solicitada. ## Currency Currency ### Listar Monedas - [GET /currency/](https://docs.zrupay.com/apis/currency/get-currencies.md): Devuelve todas las monedas. ### Obtener Moneda - [GET /currency/{currency-id}/](https://docs.zrupay.com/apis/currency/get-currency.md): Devuelve la moneda solicitada.