Create patient refund

POST

/api/patient-refunds/v1

POST

/api/patient-refunds/v1

import requests
url = "https://api.taigabilling.com/api/patient-refunds/v1"
payload = {
    "amount_cents": 1,
    "patient_external_id": "string",
    "allocations": [
        {
            "amount_cents": 1,
            "target": { "type": "service_line_by_id" }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, 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"
}

Creates a new patient refund record and returns the newly created PatientRefund object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

amount_centsintegerRequired

patient_external_idstringRequired

allocationslist of objectsRequired

refund_timestampdatetime or nullOptional

refund_notestring or nullOptional

invoicestring or nullOptionalformat: "uuid"

refund_reasonenum or nullOptional

Allowed values:

allocation_restrictionslist of objects or nullOptional

Optional restrictions constraining which claims this refund’s credit can be auto-allocated to (e.g. billing provider NPI). Restriction (type, value) pairs must be unique. When omitted, the refund is unrestricted. Refunds created from an existing payment inherit that payment’s restrictions instead.

raise_on_overdraftboolean or nullOptional

If true, the refund will be rejected if it would cause any account to be overdrafted. Defaults to false.

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

422

Unprocessable Entity Error