Skip to main content
POST
/
user
/
patient
/
{patient_id}
/
credit
Create Patient Credit
curl --request POST \
  --url https://api.decodahealth.com/user/patient/{patient_id}/credit \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "amount": 123,
  "patientId": "<string>",
  "amountRemaining": 123,
  "comment": "<string>",
  "expiryDate": "2023-11-07T05:31:56Z",
  "memberId": "<string>",
  "creatorId": "<string>"
}
'
{
  "id": "<string>",
  "patientId": "<string>",
  "amount": 123,
  "amountRemaining": 123,
  "createdDate": "2023-11-07T05:31:56Z",
  "comment": "<string>",
  "expiryDate": "2023-11-07T05:31:56Z",
  "memberId": "<string>",
  "updatedDate": "2023-11-07T05:31:56Z",
  "creator": {
    "id": "<string>",
    "type": "PROVIDER",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>"
  }
}

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

Body

application/json
​
amount
integer
required

Credit amount in cents

​
patientId
string | null
​
amountRemaining
integer | null

Amount remaining in cents, defaults to amount

​
comment
string | null
​
expiryDate
string<date-time> | null
​
memberId
string | null
​
creatorId
string | null

Response

Successful Response

​
id
string
required
​
patientId
string
required
​
amount
integer
required
​
amountRemaining
integer
required
​
createdDate
string<date-time>
required
​
comment
string | null
​
expiryDate
string<date-time> | null
​
memberId
string | null
​
updatedDate
string<date-time> | null
​
creator
UserTiny · object