Iniciando dispensación

Con este método podrás iniciar el proceso de dispensación.

Respuesta 2xx

Este endpoint puede retornar dos diferentes códigos de respuesta de éxito:

  • 201, este código HTTP usualmente se retorna para todas las recetas y para las pre-autorizaciones donde no es necesario realizar ninguna verificación con la aseguradora.
  • 202, este código HTTP únicamente se retorna en las pre-autorizaciones donde Osigu necesita realizar una verificación con la aseguradora al momento de que se realiza la dispensación.

Código HTTP 201

Nombre

Tipo

id

number
ID de la dispensación.

provider_branch_name

string
Nombre de la sucursal donde se realiza la dispensación.

sponsor_transaction_id

string
Solo para las pre-autorizaciones y donde se maneje una validación con el sponsor a la hora de la dispensación, este es el ID devuelto por el Sponsor a la hora de registrar la validación.

provider_transaction_id

string
ID de la transacción de lado del proveedor, este valor se informa al finalizar la dispensación o canje de una pre-autorización.

status

string
Estado de la pre-autorización. Los valores posibles son: IN_PROGRESS, COMPLETED, EXPIRED, VOIDED.

code

string
Código del documento dispensable (Receta o Pre-autorización).

sponsor_slug

string
Slug del sponsor que da la cobertura de la pre-autorización. En el caso de una receta este valor será nulo.

currency_code

string
Código de la moneda en que se registra la transacción, este código de moneda es según la configuración del proveedor dentro de Osigu.

amount_paid_by_patient

number
Monto pagado por el paciente, ya sea receta o pre-autorización. En el caso de una pre-autorización es la suma de deducible, copago y coaseguro.

amount_covered_by_sponsor

number
Solo para pre-autorizaciones, es el monto cubierto por la aseguradora.

deductible_amount

number
Solo para pre-autorizaciones, monto de deducible que de ser pagado por el paciente.

copayment_amount

number
Solo para pre-autorizaciones, monto de copago que de ser pagado por el paciente.

coinsurance_amount

number
Solo para pre-autorizaciones, monto de coaseguro que de ser pagado por el paciente.

products

array[object]
Listado de productos dispensados.

invoice

object
Información de la factura, en el caso de las recetas, esta factua es emitida al paciente y en el caso de pre-autorizaciones es la factura emitida al sponsor.

Inner Object - Products

Nombre

Tipo

id

string
ID del item dentro del arreglo.

product_code

string
Código de SKU del proveedor

product_name

string
Nombre del producto.

substitute_product_code

string
Código de SKU del producto substituto.

substitute_product_name

string
Nombre del producto substituto.

quantity

number
Cantidad dispensada.

currency_code

string
Código de la moneda en que se registra el precio del producto a dispensar.

price

number
Precio del producto con impuestos.

taxes

number
Impuestos agregados al producto.

coinsurance_percentage

number
Solo para pre-autorizaciones, este es el porcentaje de coaseguro que debe de cubrir el paciente.

copayment_amount

number
Solo para pre-autorizaciones, este es el monto de copago debe de cubrir el paciente.

Inner Object - Invoice

Nombre

Tipo

document_number

string
Número de factura o documento fiscal equivalente emitido al Sponsor.

document_serial

string
Número de serie de factura o documento fiscal equivalente emitido al Sponsor (Para los que aplique).

document_date

string
Fecha del documento en formato ISO.

document_digital_signature

string
Firma digital del documento (Facturas electrónicas)

Código HTTP 202

Este código solo se retornará cuando el documento a dispensar sea una pre-autorización y el Sponsor requiera que se realice una verificación con ellos en el momento de la dispensación.

Nombre

Tipo

location

string
URL de Tracking API en donde se podrá consultar el estado de la validación con el sponsor.

La URL de Tracking API se encontrará también en el response header llamado Location.

Language
Click Try It! to start a request and see the response here!