---
title: "Get Payment Link"
method: GET
path: "/billing/payment-link/{patient_id}"
tags: ["provider", "billing", "public"]
---

# Get Payment Link

`GET /billing/payment-link/{patient_id}`

## Request

- Base URL: `https://docs.decodahealth.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.decodahealth.com/billing/payment-link/{patient_id}`
- Auth: none declared. Required headers: `TENANT`, `API-KEY`
- TypeScript: <https://skmtc.dev/decodahealth/apis/decoda-api/docs/billing/payment-link/:patient_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `patient_id` string, required

## Query parameters

- `text_receipt` boolean
- `save_payment_method` boolean
- `is_surcharged` boolean, nullable

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- PublicInvoice[]
  - `charges` PublicInvoiceCharge[], required
    - `id` string, required
    - `description` string, required
    - `status` 'OUTSTANDING' | 'PAID' | 'EXTERNAL_SETTLEMENT' | 'VOID' | 'WRITE_OFF' | 'REFUNDED' | 'CHARGEBACK' | 'PAYMENT_PLAN' | 'COLLECTIONS', required
    - `total` integer, required
    - `totalOutstanding` integer, required
    - `discountAmount` integer, required
    - `externalId` string, required
    - `createdDate` string, date-time, required
  - `patient` PublicPatient, required
    - `id` string, required
    - `firstName` string, required
    - `lastName` string, nullable, required
  - `sessionKey` string, nullable
  - `payinConfigId` string, nullable
  - `gcsFileUrl` string, required
  - `sandbox` boolean, required
  - `fee` integer, nullable
  - `merchantAccount` PublicMerchantAccount, required: Public merchant account information.
    - `cardProcessingFee` number, required: Card processing fee
    - `perTransactionFee` integer, required: Per transaction fee
    - `inPersonCardProcessingFee` number, required: In-person card processing fee
    - `inPersonPerTransactionFee` integer, required: In-person per transaction fee

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/decodahealth/apis/decoda-api.md) - [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) - [OpenAPI document](https://skmtc.dev/decodahealth/apis/decoda-api/revisions/4ab18c80f9e9?raw)