Get patient payment

GET

/api/patient-payments/v4/:patient_payment_id

GET

/api/patient-payments/v4/:patient_payment_id

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

{
  "patient_payment_id": "string",
  "organization_id": "string",
  "payment_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",
  "payment_timestamp": "2024-01-15T09:30:00Z",
  "payment_note": "string",
  "invoice": "string",
  "payment_method_detail": {
    "payment_method": {
      "type": "cash"
    },
    "collected_at_address": {
      "address1": "string",
      "city": "string",
      "state": "AA",
      "zip_code": "string",
      "address2": "string",
      "zip_plus_four_code": "string"
    },
    "provider_info": {
      "npi": "string",
      "first_name": "string",
      "last_name": "string"
    }
  }
}

Retrieves a previously created patient payment by its patient_payment_id.

Authentication

AuthorizationBearer

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

Path parameters

patient_payment_idstringRequiredformat: "uuid"

Response

patient_payment_idstringformat: "uuid"

organization_idstringformat: "uuid"

payment_sourceenum

amount_centsinteger

patient_external_idstring

allocationslist of objects

source_internal_idstring or nullOptional

payment_timestampdatetime or nullOptional

payment_notestring or nullOptional

invoicestring or nullOptionalformat: "uuid"

payment_method_detailobject or nullOptional

Errors

403

Forbidden Error

404

Not Found Error