curl --request POST \
--url https://api.decodahealth.com/billing/insurance-payment/create \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"id": "<string>",
"insurer": "<string>",
"amount": 123,
"comment": "<string>",
"currency": "USD",
"locationId": "<string>",
"creatorId": "<string>"
}
'import requests
url = "https://api.decodahealth.com/billing/insurance-payment/create"
payload = {
"id": "<string>",
"insurer": "<string>",
"amount": 123,
"comment": "<string>",
"currency": "USD",
"locationId": "<string>",
"creatorId": "<string>"
}
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({
id: '<string>',
insurer: '<string>',
amount: 123,
comment: '<string>',
currency: 'USD',
locationId: '<string>',
creatorId: '<string>'
})
};
fetch('https://api.decodahealth.com/billing/insurance-payment/create', 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/insurance-payment/create",
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([
'id' => '<string>',
'insurer' => '<string>',
'amount' => 123,
'comment' => '<string>',
'currency' => 'USD',
'locationId' => '<string>',
'creatorId' => '<string>'
]),
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/insurance-payment/create"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"insurer\": \"<string>\",\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"USD\",\n \"locationId\": \"<string>\",\n \"creatorId\": \"<string>\"\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/insurance-payment/create")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"insurer\": \"<string>\",\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"USD\",\n \"locationId\": \"<string>\",\n \"creatorId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/insurance-payment/create")
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 \"id\": \"<string>\",\n \"insurer\": \"<string>\",\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"USD\",\n \"locationId\": \"<string>\",\n \"creatorId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"insurer": "<string>",
"amount": 123,
"currency": "<string>",
"status": "CANCELED",
"payinId": "<string>",
"payinConfigId": "<string>",
"paymentMedium": "POS",
"fee": 123,
"createdDate": "2023-11-07T05:31:56Z",
"comment": "<string>",
"paymentMethod": {
"id": "<string>",
"patientId": "<string>",
"rainforestPaymentMethodId": "<string>",
"brand": "<string>",
"last4": "<string>",
"expMonth": 123,
"expYear": 123,
"accountHolderType": "<string>",
"accountNumberLast4": 123,
"bankName": "<string>",
"routingNumber": 123,
"description": "<string>",
"type": "CARD",
"isDefault": false,
"isArchived": false
},
"creatorId": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Create Insurance Payment
Record an insurance payment against a charge.
curl --request POST \
--url https://api.decodahealth.com/billing/insurance-payment/create \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"id": "<string>",
"insurer": "<string>",
"amount": 123,
"comment": "<string>",
"currency": "USD",
"locationId": "<string>",
"creatorId": "<string>"
}
'import requests
url = "https://api.decodahealth.com/billing/insurance-payment/create"
payload = {
"id": "<string>",
"insurer": "<string>",
"amount": 123,
"comment": "<string>",
"currency": "USD",
"locationId": "<string>",
"creatorId": "<string>"
}
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({
id: '<string>',
insurer: '<string>',
amount: 123,
comment: '<string>',
currency: 'USD',
locationId: '<string>',
creatorId: '<string>'
})
};
fetch('https://api.decodahealth.com/billing/insurance-payment/create', 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/insurance-payment/create",
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([
'id' => '<string>',
'insurer' => '<string>',
'amount' => 123,
'comment' => '<string>',
'currency' => 'USD',
'locationId' => '<string>',
'creatorId' => '<string>'
]),
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/insurance-payment/create"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"insurer\": \"<string>\",\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"USD\",\n \"locationId\": \"<string>\",\n \"creatorId\": \"<string>\"\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/insurance-payment/create")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"insurer\": \"<string>\",\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"USD\",\n \"locationId\": \"<string>\",\n \"creatorId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/billing/insurance-payment/create")
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 \"id\": \"<string>\",\n \"insurer\": \"<string>\",\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"USD\",\n \"locationId\": \"<string>\",\n \"creatorId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"insurer": "<string>",
"amount": 123,
"currency": "<string>",
"status": "CANCELED",
"payinId": "<string>",
"payinConfigId": "<string>",
"paymentMedium": "POS",
"fee": 123,
"createdDate": "2023-11-07T05:31:56Z",
"comment": "<string>",
"paymentMethod": {
"id": "<string>",
"patientId": "<string>",
"rainforestPaymentMethodId": "<string>",
"brand": "<string>",
"last4": "<string>",
"expMonth": 123,
"expYear": 123,
"accountHolderType": "<string>",
"accountNumberLast4": 123,
"bankName": "<string>",
"routingNumber": 123,
"description": "<string>",
"type": "CARD",
"isDefault": false,
"isArchived": false
},
"creatorId": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Body
Unique identifier for the insurance payment.
Name of the insurer.
Amount of the payment.
Optional comment about the payment.
Currency of the payment.
Location of the payment.
ID of the provider who created this payment.
Response
Successful Response
Unique identifier for the insurance payment.
Name of the insurer.
Amount of the payment.
Currency of the payment.
Status of the payment.
CANCELED, CREATED, FAILED, IN_REVIEW, PRESENTING, PROCESSING, SUCCEEDED Unique identifier for the payin.
Unique identifier for the payin configuration.
Medium of the payment.
POS, VIRTUAL_TERMINAL, PAYMENT_LINK, PAYMENT_PLAN, SUBSCRIPTION, SAVED_PAYMENT_METHOD, MEMBERSHIP, CASH, CHECK, CARE_CREDIT, PATIENT_CREDIT Fee associated with the payment.
The date when the payment was created.
Optional comment about the payment.
Summary of the payment method used.
Show child attributes
Show child attributes
ID of the provider who created this payment.

