Get patient refund

GET

/api/patient-refunds/v1/:patient_refund_id

GET

/api/patient-refunds/v1/:patient_refund_id

import requests
url = "https://api.taigabilling.com/api/patient-refunds/v1/patient_refund_id"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "patient_refund_id": "string",
  "organization_id": "string",
  "refund_source": "MANUAL_ENTRY",
  "amount_cents": 1,
  "patient_external_id": "string",
  "allocations": [
    {
      "amount_cents": 1,
      "target": {
        "claim_id": "string",
        "encounter_id": "string",
        "service_line_id": "string",
        "type": "service_line"
      },
      "allocation_id": "string",
      "earmark": {
        "id": "string",
        "target": {
          "type": "date_of_service",
          "value": "string"
        },
        "amount_earmarked_cents": 1,
        "created_by_allocation_id": "string"
      },
      "allocated_on": "2024-01-15T09:30:00Z"
    }
  ],
  "source_internal_id": "string",
  "refund_timestamp": "2024-01-15T09:30:00Z",
  "refund_note": "string",
  "invoice": "string",
  "refund_reason": "OVERCHARGED"
}

Retrieves a previously created patient refund by its patient_refund_id.

Authentication

AuthorizationBearer

Send your Taiga API key as a Bearer token. Create and manage keys in the Taiga developer portal.

Path parameters

patient_refund_idstringRequiredformat: "uuid"

Response

patient_refund_idstringformat: "uuid"

organization_idstringformat: "uuid"

refund_sourceenum

amount_centsinteger

patient_external_idstring

allocationslist of objects

source_internal_idstring or nullOptional

refund_timestampdatetime or nullOptional

refund_notestring or nullOptional

invoicestring or nullOptionalformat: "uuid"

refund_reasonenum or nullOptional

Allowed values:

Errors

403

Forbidden Error

404

Not Found Error