Create Patient Credit Settled
curl --request POST \
--url https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
[
{
"patientId": "<string>",
"totalOutstanding": 123,
"id": "<string>",
"patient": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"total": 0,
"description": "<string>",
"status": "OUTSTANDING",
"discountAmount": 0,
"discountPercentage": 0,
"externalId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"ruleSetId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"items": [],
"tips": [],
"locationId": "<string>",
"eventId": "<string>",
"memberId": "<string>",
"comment": "<string>",
"meta": {},
"merchantAccountId": "<string>",
"payments": [],
"adjustments": []
}
]
'import requests
url = "https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled"
payload = [
{
"patientId": "<string>",
"totalOutstanding": 123,
"id": "<string>",
"patient": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": True,
"meta": {},
"isArchived": True,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": ["<string>"],
"onSchedulingBlacklist": True,
"surchargeDisabled": True,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": True,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"total": 0,
"description": "<string>",
"status": "OUTSTANDING",
"discountAmount": 0,
"discountPercentage": 0,
"externalId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"ruleSetId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"items": [],
"tips": [],
"locationId": "<string>",
"eventId": "<string>",
"memberId": "<string>",
"comment": "<string>",
"meta": {},
"merchantAccountId": "<string>",
"payments": [],
"adjustments": []
}
]
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
patientId: '<string>',
totalOutstanding: 123,
id: '<string>',
patient: {
id: '<string>',
createdDate: '2023-11-07T05:31:56Z',
firstName: '<string>',
lastName: '<string>',
phoneNumber: '<string>',
email: '<string>',
locationId: '<string>',
externalId: '<string>',
address: '<string>',
addressLineTwo: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>',
country: '<string>',
addressValid: true,
meta: {},
isArchived: true,
primaryLocationId: '<string>',
gender: '<string>',
dateOfBirth: '2023-12-25',
patientMedications: ['<string>'],
onSchedulingBlacklist: true,
surchargeDisabled: true,
tags: [
{
id: '<string>',
name: '<string>',
isActive: true,
createdDate: '2023-11-07T05:31:56Z',
emoji: '<string>',
color: '<string>',
updatedDate: '2023-11-07T05:31:56Z'
}
],
creditBalance: 123,
preferredProviderId: '<string>'
},
total: 0,
description: '<string>',
status: 'OUTSTANDING',
discountAmount: 0,
discountPercentage: 0,
externalId: '<string>',
externalCreatedDate: '2023-11-07T05:31:56Z',
ruleSetId: '<string>',
createdDate: '2023-11-07T05:31:56Z',
creatorId: '<string>',
items: [],
tips: [],
locationId: '<string>',
eventId: '<string>',
memberId: '<string>',
comment: '<string>',
meta: {},
merchantAccountId: '<string>',
payments: [],
adjustments: []
}
])
};
fetch('https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'patientId' => '<string>',
'totalOutstanding' => 123,
'id' => '<string>',
'patient' => [
'id' => '<string>',
'createdDate' => '2023-11-07T05:31:56Z',
'firstName' => '<string>',
'lastName' => '<string>',
'phoneNumber' => '<string>',
'email' => '<string>',
'locationId' => '<string>',
'externalId' => '<string>',
'address' => '<string>',
'addressLineTwo' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>',
'country' => '<string>',
'addressValid' => true,
'meta' => [
],
'isArchived' => true,
'primaryLocationId' => '<string>',
'gender' => '<string>',
'dateOfBirth' => '2023-12-25',
'patientMedications' => [
'<string>'
],
'onSchedulingBlacklist' => true,
'surchargeDisabled' => true,
'tags' => [
[
'id' => '<string>',
'name' => '<string>',
'isActive' => true,
'createdDate' => '2023-11-07T05:31:56Z',
'emoji' => '<string>',
'color' => '<string>',
'updatedDate' => '2023-11-07T05:31:56Z'
]
],
'creditBalance' => 123,
'preferredProviderId' => '<string>'
],
'total' => 0,
'description' => '<string>',
'status' => 'OUTSTANDING',
'discountAmount' => 0,
'discountPercentage' => 0,
'externalId' => '<string>',
'externalCreatedDate' => '2023-11-07T05:31:56Z',
'ruleSetId' => '<string>',
'createdDate' => '2023-11-07T05:31:56Z',
'creatorId' => '<string>',
'items' => [
],
'tips' => [
],
'locationId' => '<string>',
'eventId' => '<string>',
'memberId' => '<string>',
'comment' => '<string>',
'meta' => [
],
'merchantAccountId' => '<string>',
'payments' => [
],
'adjustments' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled"
payload := strings.NewReader("[\n {\n \"patientId\": \"<string>\",\n \"totalOutstanding\": 123,\n \"id\": \"<string>\",\n \"patient\": {\n \"id\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"locationId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"address\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addressValid\": true,\n \"meta\": {},\n \"isArchived\": true,\n \"primaryLocationId\": \"<string>\",\n \"gender\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"patientMedications\": [\n \"<string>\"\n ],\n \"onSchedulingBlacklist\": true,\n \"surchargeDisabled\": true,\n \"tags\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"isActive\": true,\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"emoji\": \"<string>\",\n \"color\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"creditBalance\": 123,\n \"preferredProviderId\": \"<string>\"\n },\n \"total\": 0,\n \"description\": \"<string>\",\n \"status\": \"OUTSTANDING\",\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"externalId\": \"<string>\",\n \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n \"ruleSetId\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"creatorId\": \"<string>\",\n \"items\": [],\n \"tips\": [],\n \"locationId\": \"<string>\",\n \"eventId\": \"<string>\",\n \"memberId\": \"<string>\",\n \"comment\": \"<string>\",\n \"meta\": {},\n \"merchantAccountId\": \"<string>\",\n \"payments\": [],\n \"adjustments\": []\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"patientId\": \"<string>\",\n \"totalOutstanding\": 123,\n \"id\": \"<string>\",\n \"patient\": {\n \"id\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"locationId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"address\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addressValid\": true,\n \"meta\": {},\n \"isArchived\": true,\n \"primaryLocationId\": \"<string>\",\n \"gender\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"patientMedications\": [\n \"<string>\"\n ],\n \"onSchedulingBlacklist\": true,\n \"surchargeDisabled\": true,\n \"tags\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"isActive\": true,\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"emoji\": \"<string>\",\n \"color\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"creditBalance\": 123,\n \"preferredProviderId\": \"<string>\"\n },\n \"total\": 0,\n \"description\": \"<string>\",\n \"status\": \"OUTSTANDING\",\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"externalId\": \"<string>\",\n \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n \"ruleSetId\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"creatorId\": \"<string>\",\n \"items\": [],\n \"tips\": [],\n \"locationId\": \"<string>\",\n \"eventId\": \"<string>\",\n \"memberId\": \"<string>\",\n \"comment\": \"<string>\",\n \"meta\": {},\n \"merchantAccountId\": \"<string>\",\n \"payments\": [],\n \"adjustments\": []\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"patientId\": \"<string>\",\n \"totalOutstanding\": 123,\n \"id\": \"<string>\",\n \"patient\": {\n \"id\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"locationId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"address\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addressValid\": true,\n \"meta\": {},\n \"isArchived\": true,\n \"primaryLocationId\": \"<string>\",\n \"gender\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"patientMedications\": [\n \"<string>\"\n ],\n \"onSchedulingBlacklist\": true,\n \"surchargeDisabled\": true,\n \"tags\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"isActive\": true,\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"emoji\": \"<string>\",\n \"color\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"creditBalance\": 123,\n \"preferredProviderId\": \"<string>\"\n },\n \"total\": 0,\n \"description\": \"<string>\",\n \"status\": \"OUTSTANDING\",\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"externalId\": \"<string>\",\n \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n \"ruleSetId\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"creatorId\": \"<string>\",\n \"items\": [],\n \"tips\": [],\n \"locationId\": \"<string>\",\n \"eventId\": \"<string>\",\n \"memberId\": \"<string>\",\n \"comment\": \"<string>\",\n \"meta\": {},\n \"merchantAccountId\": \"<string>\",\n \"payments\": [],\n \"adjustments\": []\n }\n]"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"amount": 123,
"paymentMedium": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"feeToPatient": 123,
"patientId": "<string>",
"payinId": "<string>",
"currency": "USD",
"payinConfigId": "<string>",
"paymentMethodId": "<string>",
"stripePaymentIntentId": "<string>",
"failedReason": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"fee": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Payment Terminals
Create Patient Credit Settled
Create a patient credit payment for charges.
If credit_ids is provided, uses only those specific credits. Otherwise, credits are applied in FIFO order (oldest first).
POST
/
billing
/
payment-terminal
/
charge
/
create-patient-credit-settled
Create Patient Credit Settled
curl --request POST \
--url https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
[
{
"patientId": "<string>",
"totalOutstanding": 123,
"id": "<string>",
"patient": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"total": 0,
"description": "<string>",
"status": "OUTSTANDING",
"discountAmount": 0,
"discountPercentage": 0,
"externalId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"ruleSetId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"items": [],
"tips": [],
"locationId": "<string>",
"eventId": "<string>",
"memberId": "<string>",
"comment": "<string>",
"meta": {},
"merchantAccountId": "<string>",
"payments": [],
"adjustments": []
}
]
'import requests
url = "https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled"
payload = [
{
"patientId": "<string>",
"totalOutstanding": 123,
"id": "<string>",
"patient": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": True,
"meta": {},
"isArchived": True,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": ["<string>"],
"onSchedulingBlacklist": True,
"surchargeDisabled": True,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": True,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"total": 0,
"description": "<string>",
"status": "OUTSTANDING",
"discountAmount": 0,
"discountPercentage": 0,
"externalId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"ruleSetId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"items": [],
"tips": [],
"locationId": "<string>",
"eventId": "<string>",
"memberId": "<string>",
"comment": "<string>",
"meta": {},
"merchantAccountId": "<string>",
"payments": [],
"adjustments": []
}
]
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
patientId: '<string>',
totalOutstanding: 123,
id: '<string>',
patient: {
id: '<string>',
createdDate: '2023-11-07T05:31:56Z',
firstName: '<string>',
lastName: '<string>',
phoneNumber: '<string>',
email: '<string>',
locationId: '<string>',
externalId: '<string>',
address: '<string>',
addressLineTwo: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>',
country: '<string>',
addressValid: true,
meta: {},
isArchived: true,
primaryLocationId: '<string>',
gender: '<string>',
dateOfBirth: '2023-12-25',
patientMedications: ['<string>'],
onSchedulingBlacklist: true,
surchargeDisabled: true,
tags: [
{
id: '<string>',
name: '<string>',
isActive: true,
createdDate: '2023-11-07T05:31:56Z',
emoji: '<string>',
color: '<string>',
updatedDate: '2023-11-07T05:31:56Z'
}
],
creditBalance: 123,
preferredProviderId: '<string>'
},
total: 0,
description: '<string>',
status: 'OUTSTANDING',
discountAmount: 0,
discountPercentage: 0,
externalId: '<string>',
externalCreatedDate: '2023-11-07T05:31:56Z',
ruleSetId: '<string>',
createdDate: '2023-11-07T05:31:56Z',
creatorId: '<string>',
items: [],
tips: [],
locationId: '<string>',
eventId: '<string>',
memberId: '<string>',
comment: '<string>',
meta: {},
merchantAccountId: '<string>',
payments: [],
adjustments: []
}
])
};
fetch('https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'patientId' => '<string>',
'totalOutstanding' => 123,
'id' => '<string>',
'patient' => [
'id' => '<string>',
'createdDate' => '2023-11-07T05:31:56Z',
'firstName' => '<string>',
'lastName' => '<string>',
'phoneNumber' => '<string>',
'email' => '<string>',
'locationId' => '<string>',
'externalId' => '<string>',
'address' => '<string>',
'addressLineTwo' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>',
'country' => '<string>',
'addressValid' => true,
'meta' => [
],
'isArchived' => true,
'primaryLocationId' => '<string>',
'gender' => '<string>',
'dateOfBirth' => '2023-12-25',
'patientMedications' => [
'<string>'
],
'onSchedulingBlacklist' => true,
'surchargeDisabled' => true,
'tags' => [
[
'id' => '<string>',
'name' => '<string>',
'isActive' => true,
'createdDate' => '2023-11-07T05:31:56Z',
'emoji' => '<string>',
'color' => '<string>',
'updatedDate' => '2023-11-07T05:31:56Z'
]
],
'creditBalance' => 123,
'preferredProviderId' => '<string>'
],
'total' => 0,
'description' => '<string>',
'status' => 'OUTSTANDING',
'discountAmount' => 0,
'discountPercentage' => 0,
'externalId' => '<string>',
'externalCreatedDate' => '2023-11-07T05:31:56Z',
'ruleSetId' => '<string>',
'createdDate' => '2023-11-07T05:31:56Z',
'creatorId' => '<string>',
'items' => [
],
'tips' => [
],
'locationId' => '<string>',
'eventId' => '<string>',
'memberId' => '<string>',
'comment' => '<string>',
'meta' => [
],
'merchantAccountId' => '<string>',
'payments' => [
],
'adjustments' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled"
payload := strings.NewReader("[\n {\n \"patientId\": \"<string>\",\n \"totalOutstanding\": 123,\n \"id\": \"<string>\",\n \"patient\": {\n \"id\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"locationId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"address\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addressValid\": true,\n \"meta\": {},\n \"isArchived\": true,\n \"primaryLocationId\": \"<string>\",\n \"gender\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"patientMedications\": [\n \"<string>\"\n ],\n \"onSchedulingBlacklist\": true,\n \"surchargeDisabled\": true,\n \"tags\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"isActive\": true,\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"emoji\": \"<string>\",\n \"color\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"creditBalance\": 123,\n \"preferredProviderId\": \"<string>\"\n },\n \"total\": 0,\n \"description\": \"<string>\",\n \"status\": \"OUTSTANDING\",\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"externalId\": \"<string>\",\n \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n \"ruleSetId\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"creatorId\": \"<string>\",\n \"items\": [],\n \"tips\": [],\n \"locationId\": \"<string>\",\n \"eventId\": \"<string>\",\n \"memberId\": \"<string>\",\n \"comment\": \"<string>\",\n \"meta\": {},\n \"merchantAccountId\": \"<string>\",\n \"payments\": [],\n \"adjustments\": []\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"patientId\": \"<string>\",\n \"totalOutstanding\": 123,\n \"id\": \"<string>\",\n \"patient\": {\n \"id\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"locationId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"address\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addressValid\": true,\n \"meta\": {},\n \"isArchived\": true,\n \"primaryLocationId\": \"<string>\",\n \"gender\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"patientMedications\": [\n \"<string>\"\n ],\n \"onSchedulingBlacklist\": true,\n \"surchargeDisabled\": true,\n \"tags\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"isActive\": true,\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"emoji\": \"<string>\",\n \"color\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"creditBalance\": 123,\n \"preferredProviderId\": \"<string>\"\n },\n \"total\": 0,\n \"description\": \"<string>\",\n \"status\": \"OUTSTANDING\",\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"externalId\": \"<string>\",\n \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n \"ruleSetId\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"creatorId\": \"<string>\",\n \"items\": [],\n \"tips\": [],\n \"locationId\": \"<string>\",\n \"eventId\": \"<string>\",\n \"memberId\": \"<string>\",\n \"comment\": \"<string>\",\n \"meta\": {},\n \"merchantAccountId\": \"<string>\",\n \"payments\": [],\n \"adjustments\": []\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"patientId\": \"<string>\",\n \"totalOutstanding\": 123,\n \"id\": \"<string>\",\n \"patient\": {\n \"id\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"locationId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"address\": \"<string>\",\n \"addressLineTwo\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"addressValid\": true,\n \"meta\": {},\n \"isArchived\": true,\n \"primaryLocationId\": \"<string>\",\n \"gender\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"patientMedications\": [\n \"<string>\"\n ],\n \"onSchedulingBlacklist\": true,\n \"surchargeDisabled\": true,\n \"tags\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"isActive\": true,\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"emoji\": \"<string>\",\n \"color\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"creditBalance\": 123,\n \"preferredProviderId\": \"<string>\"\n },\n \"total\": 0,\n \"description\": \"<string>\",\n \"status\": \"OUTSTANDING\",\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"externalId\": \"<string>\",\n \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n \"ruleSetId\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"creatorId\": \"<string>\",\n \"items\": [],\n \"tips\": [],\n \"locationId\": \"<string>\",\n \"eventId\": \"<string>\",\n \"memberId\": \"<string>\",\n \"comment\": \"<string>\",\n \"meta\": {},\n \"merchantAccountId\": \"<string>\",\n \"payments\": [],\n \"adjustments\": []\n }\n]"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"amount": 123,
"paymentMedium": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"feeToPatient": 123,
"patientId": "<string>",
"payinId": "<string>",
"currency": "USD",
"payinConfigId": "<string>",
"paymentMethodId": "<string>",
"stripePaymentIntentId": "<string>",
"failedReason": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"fee": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Query Parameters
Body
application/json
Identifier of the patient being charged.
Total outstanding amount that is yet to be paid.
A unique identifier for the charge. Auto-generated if not provided.
Summary details of the patient being charged.
Show child attributes
Show child attributes
Total amount of the charge.
Description of the charge.
Current status of the charge.
Available options:
OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, CHARGEBACK, PAYMENT_PLAN, COLLECTIONS Any discount applied to the total outstanding.
Percentage of discount applied to the charge.
External identifier for the charge, if applicable.
The creation date of the charge in your external system, if applicable.
Identifier for the RuleSet applied to this Charge, if any.
The date when the charge was created.
Identifier of the Provider who created the charge (i.e. the Clinician, or relevant Biller).
List of Items in the Charge.
Show child attributes
Show child attributes
List of Tips in the Charge.
Show child attributes
Show child attributes
Identifier of the Location where the charge was created.
Identifier of the Event this charge is associated with, if any.
Identifier of the Member this charge is associated with, if any.
Any additional comments about the charge.
Any additional metadata about the charge relevant to your system.
Identifier of the MerchantAccount this charge is associated with.
List of Payments in the Charge.
Show child attributes
Show child attributes
List of Adjustments in the Charge.
Show child attributes
Show child attributes
Response
Successful Response
The unique identifier for the payment.
The total amount of the payment.
The current status of the payment.
Available options:
CANCELED, CREATED, FAILED, IN_REVIEW, PRESENTING, PROCESSING, SUCCEEDED The name of the payment medium.
The date and time the payment was created.
The fee charged to the patient for the transaction.
The ID of the patient associated with the payment.
The ID of the payin associated with the payment.
The currency in which the payment was made.
The configuration ID for the payin.
The ID of the payment method used.
Stripe's payment intent ID if used.
Reason for payment failure if applicable.
The date and time the payment was last updated.
The fee charged by the payment processor.
⌘I