Skip to main content
GET
/
billing
/
payment-link
/
{patient_id}
Get Payment Link
curl --request GET \
  --url https://api.decodahealth.com/billing/payment-link/{patient_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "charges": [
      {
        "id": "<string>",
        "description": "<string>",
        "status": "OUTSTANDING",
        "total": 123,
        "totalOutstanding": 123,
        "discountAmount": 123,
        "externalId": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      }
    ],
    "patient": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "gcsFileUrl": "<string>",
    "sandbox": true,
    "merchantAccount": {
      "cardProcessingFee": 123,
      "perTransactionFee": 123,
      "inPersonCardProcessingFee": 123,
      "inPersonPerTransactionFee": 123
    },
    "sessionKey": "<string>",
    "payinConfigId": "<string>",
    "fee": 0
  }
]

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

patient_id
string
required

Query Parameters

text_receipt
boolean
default:false
save_payment_method
boolean
default:false
is_surcharged
boolean | null

Response

Successful Response

charges
PublicInvoiceCharge · object[]
required
patient
PublicPatient · object
required
gcsFileUrl
string
required
sandbox
boolean
required
merchantAccount
PublicMerchantAccount · object
required

Public merchant account information.

sessionKey
string | null
payinConfigId
string | null
fee
integer | null
default:0