Create insurance refund

POST

/api/insurance-refunds/v1

POST

/api/insurance-refunds/v1

import requests
url = "https://api.taigabilling.com/api/insurance-refunds/v1"
payload = {
    "payer_identifier": {
        "payer_id": "string",
        "payer_name": "string",
        "type": "payer_info"
    },
    "amount_cents": 1,
    "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())

{
  "insurance_refund_id": "string",
  "payer": {
    "payer_uuid": "string",
    "payer_id": "12345",
    "payer_name": "Payer Name",
    "availity_payer_name": "string",
    "availity_claims_payer_id": "string",
    "availity_eligibility_id": "string",
    "availity_remittance_payer_id": "string",
    "street_address": {
      "address1": "string",
      "city": "string",
      "state": "AA",
      "zip_code": "string",
      "zip_plus_four_code": "1234",
      "address2": "string"
    }
  },
  "amount_cents": 1,
  "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"
    }
  ],
  "refund_timestamp": "2024-01-15T09:30:00Z",
  "refund_note": "string",
  "refund_reason": "OVERCHARGED"
}

Creates a new insurance refund record and returns the newly created InsuranceRefund 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.

payer_identifierobjectRequired

amount_centsintegerRequired

allocationslist of objectsRequired

refund_timestampdatetime or nullOptional

refund_notestring or nullOptional

refund_reasonenum or nullOptional

Allowed values:

Response

insurance_refund_idstringformat: "uuid"

payerobject

amount_centsinteger

allocationslist of objects

refund_timestampdatetime or nullOptional

refund_notestring or nullOptional

refund_reasonenum or nullOptional

Allowed values:

Errors

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error