--- updatedAt: 2025-06-11T01:56:03.000Z agentTools: projectIndex: https://developers.osigu.com/llms.txt --- # Dispensación La plataforma de Osigu llama a este webhook cada vez que una dispensación de una autorización es registrada por uno de los proveedores pertenecientes a la red. La respuesta de este servicio debe de incluir el siguiente campo. * `payer_transaction_id`, es un identificador de la transacción correspondiente a la creación del registro de dispensación de autorización de lado del Payer. Este ID de transacción es requerido por temas de auditoría y soporte. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "payer-api", "version": "4.0" }, "servers": [ { "url": "https://payer-domain-name.com/webhooks" } ], "security": [ {} ], "paths": { "/v1/claims": { "post": { "summary": "Dispensación", "description": "La plataforma de Osigu llama a este webhook cada vez que una dispensación de una autorización es registrada por uno de los proveedores pertenecientes a la red.", "operationId": "getting-started-with-your-api-1", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "event_type", "code", "claim_id", "country_code", "currency_code", "provider_tax_identification_number", "document_number", "total_amount", "items", "created_at" ], "properties": { "event_type": { "type": "string", "description": "El tipo de evento que se está notificando.", "default": "CLAIM_CREATED", "enum": [ "AUTHORIZATION_CREATED", "AUTHORIZATION_VOIDED", "CLAIM_CREATED", "CLAIM_VOIDED" ] }, "code": { "type": "string", "description": "Es el código de la autorización sobre la cuál están realizando una dispensación.", "default": "JOE1PW2Z" }, "claim_id": { "type": "string", "description": "ID de la dispensación.", "default": "9937264" }, "country_code": { "type": "string", "description": "Código del país del proveedor donde ocurre la dispensación.", "default": "GT" }, "currency_code": { "type": "string", "description": "Código de la moneda utilizada en la dispensación.", "default": "GTQ" }, "deductible_amount": { "type": "number", "description": "Monto de deducible aplicado a la transacción.", "default": 0, "format": "double" }, "copayment_amount": { "type": "number", "description": "Monto de copago aplicado a la transaccion.", "default": 150.5, "format": "double" }, "coinsurance_amount": { "type": "number", "description": "Monto de coaseguro calculado para la transacción.", "default": 380.5, "format": "double" }, "provider_tax_identification_number": { "type": "string", "description": "Código o identificador fiscal del proveedor.", "default": "3920391-9" }, "provider_name": { "type": "string", "description": "Nombre del proveedor donde ocurre la dispensación.", "default": "Mi farmacia." }, "document_serial": { "type": "string", "description": "Numero de serie del documento fiscal que extiende el proveedor al Payer.", "default": "S-1158" }, "document_number": { "type": "string", "description": "El número del documento que se extiende al Payer por parte del proveedor.", "default": "839210" }, "document_digital_signature": { "type": "string", "description": "Es la firma digital del documento fiscal que se extiende al Payer por parte del proveedor.", "default": "OmGCvGkxKgQdbVl87ZLFR5PsOFcLWZ4MKVji40xzYH3MJKG9wDSd2g==" }, "total_amount": { "type": "number", "description": "Monto total de la transaccion.", "default": 1502.6, "format": "double" }, "cashout_by_osigu": { "type": "boolean", "description": "Indica si Osigu realizará adelanto de pago de dicha transacción al proveedor.", "default": true }, "items": { "type": "array", "description": "Productos/servicios de la autorización que han sido dispensados.", "items": { "properties": { "authorization_item_id": { "type": "integer", "description": "Esta es una identificación numérica asociada a cada elemento", "default": 1293, "format": "int64" }, "type": { "type": "string", "description": "Este es el tipo de producto. ENUM : drug, laboratory, diagnostic-test, medical-procedure", "default": "drug" }, "group": { "type": "string", "description": "Este es el grupo de productos. ENUM : non-generic-drug, generic-drug", "default": "non-generic-drug" }, "name": { "type": "string", "description": "Este es el nombre del producto.", "default": "Nexium 20 mgs caja de 28 tabletas" }, "quantity": { "type": "integer", "description": "Esta es la cantidad autorizada", "default": 1, "format": "int32" }, "status": { "type": "string", "description": "Este es el resultado de las validaciones de los protocolos médicos, si el artículo es rechazado, tendrá una razón para el rechazo ENUM: APPROVED, REJECTED, MANUAL_APPROVAL_REQUIRED, PARTIALLY_CLAIMED, CLAIMED", "default": "approved" }, "reason": { "type": "string", "description": "La razón por la cual el artículo fue rechazado", "default": "No existe un diagnóstico relacionado con los ingredientes de este producto." }, "recurrence": { "type": "integer", "description": "El número de recurrencia para este elemento de autorización.", "format": "int32" }, "total_of_recurrence": { "type": "integer", "description": "Este es el número de recurrencias totales desde la primera autorización incluida en la misma solicitud de autorización.", "format": "int32" } }, "required": [ "authorization_item_id", "group", "name", "quantity", "status" ], "type": "object" } }, "created_at": { "type": "string", "description": "Fecha de creacion del reclamo.", "default": "2016-08-05T08:40:51.620Z" } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"payer_transaction_id\": \"1023\"\n}" } }, "schema": { "type": "object", "properties": { "payer_transaction_id": { "type": "string", "example": "1023" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "security": [] } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```