Create Patient Credit Payment

curl --request POST \
  --url https://api.decodahealth.com/billing/payment/patient-credit/create \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "id": "<string>",
  "total": 123,
  "totalOutstanding": 123,
  "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>"
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "adjustments": [
    {
      "chargeId": "<string>",
      "id": "<string>",
      "amount": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "providerId": "<string>",
      "locationId": "<string>",
      "reason": "<string>"
    }
  ],
  "payments": [
    {
      "id": "<string>",
      "amount": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "paymentMedium": "<string>",
      "refunds": [
        {
          "id": "<string>",
          "amount": 123,
          "createdDate": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "creator": {
            "id": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "phoneNumber": "<string>",
            "email": "<string>",
            "locationId": "<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>",
        "isDefault": false,
        "isArchived": false
      }
    }
  ],
  "plannedPayments": [
    {
      "id": "<string>",
      "amount": 123,
      "paymentDate": "2023-11-07T05:31:56Z"
    }
  ],
  "items": [
    {
      "chargeId": "<string>",
      "quantity": 123,
      "price": 123,
      "id": "<string>",
      "itemId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "discountAmount": 123,
      "discountPercentage": 123,
      "discountReason": "<string>",
      "soldPackageId": "<string>",
      "bankedQuantity": 123,
      "bankedItemId": "<string>",
      "issuedDiscountId": "<string>",
      "soldByProviderId": "<string>",
      "taxAmount": 123,
      "pricingId": "<string>",
      "shipmentIds": [
        "<string>"
      ]
    }
  ],
  "description": "<string>",
  "ruleSetId": "<string>",
  "externalCreatedDate": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "creator": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>"
  },
  "comment": "<string>",
  "locationId": "<string>",
  "tips": []
}
'

import requests

url = "https://api.decodahealth.com/billing/payment/patient-credit/create"

payload = {
    "id": "<string>",
    "total": 123,
    "totalOutstanding": 123,
    "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>"
    },
    "createdDate": "2023-11-07T05:31:56Z",
    "adjustments": [
        {
            "chargeId": "<string>",
            "id": "<string>",
            "amount": 123,
            "createdDate": "2023-11-07T05:31:56Z",
            "providerId": "<string>",
            "locationId": "<string>",
            "reason": "<string>"
        }
    ],
    "payments": [
        {
            "id": "<string>",
            "amount": 123,
            "createdDate": "2023-11-07T05:31:56Z",
            "paymentMedium": "<string>",
            "refunds": [
                {
                    "id": "<string>",
                    "amount": 123,
                    "createdDate": "2023-11-07T05:31:56Z",
                    "description": "<string>",
                    "creator": {
                        "id": "<string>",
                        "firstName": "<string>",
                        "lastName": "<string>",
                        "phoneNumber": "<string>",
                        "email": "<string>",
                        "locationId": "<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>",
                "isDefault": False,
                "isArchived": False
            }
        }
    ],
    "plannedPayments": [
        {
            "id": "<string>",
            "amount": 123,
            "paymentDate": "2023-11-07T05:31:56Z"
        }
    ],
    "items": [
        {
            "chargeId": "<string>",
            "quantity": 123,
            "price": 123,
            "id": "<string>",
            "itemId": "<string>",
            "name": "<string>",
            "description": "<string>",
            "discountAmount": 123,
            "discountPercentage": 123,
            "discountReason": "<string>",
            "soldPackageId": "<string>",
            "bankedQuantity": 123,
            "bankedItemId": "<string>",
            "issuedDiscountId": "<string>",
            "soldByProviderId": "<string>",
            "taxAmount": 123,
            "pricingId": "<string>",
            "shipmentIds": ["<string>"]
        }
    ],
    "description": "<string>",
    "ruleSetId": "<string>",
    "externalCreatedDate": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>"
    },
    "comment": "<string>",
    "locationId": "<string>",
    "tips": []
}
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>',
    total: 123,
    totalOutstanding: 123,
    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>'
    },
    createdDate: '2023-11-07T05:31:56Z',
    adjustments: [
      {
        chargeId: '<string>',
        id: '<string>',
        amount: 123,
        createdDate: '2023-11-07T05:31:56Z',
        providerId: '<string>',
        locationId: '<string>',
        reason: '<string>'
      }
    ],
    payments: [
      {
        id: '<string>',
        amount: 123,
        createdDate: '2023-11-07T05:31:56Z',
        paymentMedium: '<string>',
        refunds: [
          {
            id: '<string>',
            amount: 123,
            createdDate: '2023-11-07T05:31:56Z',
            description: '<string>',
            creator: {
              id: '<string>',
              firstName: '<string>',
              lastName: '<string>',
              phoneNumber: '<string>',
              email: '<string>',
              locationId: '<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>',
          isDefault: false,
          isArchived: false
        }
      }
    ],
    plannedPayments: [{id: '<string>', amount: 123, paymentDate: '2023-11-07T05:31:56Z'}],
    items: [
      {
        chargeId: '<string>',
        quantity: 123,
        price: 123,
        id: '<string>',
        itemId: '<string>',
        name: '<string>',
        description: '<string>',
        discountAmount: 123,
        discountPercentage: 123,
        discountReason: '<string>',
        soldPackageId: '<string>',
        bankedQuantity: 123,
        bankedItemId: '<string>',
        issuedDiscountId: '<string>',
        soldByProviderId: '<string>',
        taxAmount: 123,
        pricingId: '<string>',
        shipmentIds: ['<string>']
      }
    ],
    description: '<string>',
    ruleSetId: '<string>',
    externalCreatedDate: '2023-11-07T05:31:56Z',
    externalId: '<string>',
    creator: {
      id: '<string>',
      firstName: '<string>',
      lastName: '<string>',
      phoneNumber: '<string>',
      email: '<string>',
      locationId: '<string>'
    },
    comment: '<string>',
    locationId: '<string>',
    tips: []
  })
};

fetch('https://api.decodahealth.com/billing/payment/patient-credit/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/payment/patient-credit/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>',
    'total' => 123,
    'totalOutstanding' => 123,
    '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>'
    ],
    'createdDate' => '2023-11-07T05:31:56Z',
    'adjustments' => [
        [
                'chargeId' => '<string>',
                'id' => '<string>',
                'amount' => 123,
                'createdDate' => '2023-11-07T05:31:56Z',
                'providerId' => '<string>',
                'locationId' => '<string>',
                'reason' => '<string>'
        ]
    ],
    'payments' => [
        [
                'id' => '<string>',
                'amount' => 123,
                'createdDate' => '2023-11-07T05:31:56Z',
                'paymentMedium' => '<string>',
                'refunds' => [
                                [
                                                                'id' => '<string>',
                                                                'amount' => 123,
                                                                'createdDate' => '2023-11-07T05:31:56Z',
                                                                'description' => '<string>',
                                                                'creator' => [
                                                                                                                                'id' => '<string>',
                                                                                                                                'firstName' => '<string>',
                                                                                                                                'lastName' => '<string>',
                                                                                                                                'phoneNumber' => '<string>',
                                                                                                                                'email' => '<string>',
                                                                                                                                'locationId' => '<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>',
                                'isDefault' => false,
                                'isArchived' => false
                ]
        ]
    ],
    'plannedPayments' => [
        [
                'id' => '<string>',
                'amount' => 123,
                'paymentDate' => '2023-11-07T05:31:56Z'
        ]
    ],
    'items' => [
        [
                'chargeId' => '<string>',
                'quantity' => 123,
                'price' => 123,
                'id' => '<string>',
                'itemId' => '<string>',
                'name' => '<string>',
                'description' => '<string>',
                'discountAmount' => 123,
                'discountPercentage' => 123,
                'discountReason' => '<string>',
                'soldPackageId' => '<string>',
                'bankedQuantity' => 123,
                'bankedItemId' => '<string>',
                'issuedDiscountId' => '<string>',
                'soldByProviderId' => '<string>',
                'taxAmount' => 123,
                'pricingId' => '<string>',
                'shipmentIds' => [
                                '<string>'
                ]
        ]
    ],
    'description' => '<string>',
    'ruleSetId' => '<string>',
    'externalCreatedDate' => '2023-11-07T05:31:56Z',
    'externalId' => '<string>',
    'creator' => [
        'id' => '<string>',
        'firstName' => '<string>',
        'lastName' => '<string>',
        'phoneNumber' => '<string>',
        'email' => '<string>',
        'locationId' => '<string>'
    ],
    'comment' => '<string>',
    'locationId' => '<string>',
    'tips' => [
        
    ]
  ]),
  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/patient-credit/create"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"total\": 123,\n  \"totalOutstanding\": 123,\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  \"createdDate\": \"2023-11-07T05:31:56Z\",\n  \"adjustments\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"providerId\": \"<string>\",\n      \"locationId\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"payments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"paymentMedium\": \"<string>\",\n      \"refunds\": [\n        {\n          \"id\": \"<string>\",\n          \"amount\": 123,\n          \"createdDate\": \"2023-11-07T05:31:56Z\",\n          \"description\": \"<string>\",\n          \"creator\": {\n            \"id\": \"<string>\",\n            \"firstName\": \"<string>\",\n            \"lastName\": \"<string>\",\n            \"phoneNumber\": \"<string>\",\n            \"email\": \"<string>\",\n            \"locationId\": \"<string>\"\n          }\n        }\n      ],\n      \"paymentMethod\": {\n        \"id\": \"<string>\",\n        \"patientId\": \"<string>\",\n        \"rainforestPaymentMethodId\": \"<string>\",\n        \"brand\": \"<string>\",\n        \"last4\": \"<string>\",\n        \"expMonth\": 123,\n        \"expYear\": 123,\n        \"accountHolderType\": \"<string>\",\n        \"accountNumberLast4\": 123,\n        \"bankName\": \"<string>\",\n        \"routingNumber\": 123,\n        \"description\": \"<string>\",\n        \"isDefault\": false,\n        \"isArchived\": false\n      }\n    }\n  ],\n  \"plannedPayments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"paymentDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"items\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"quantity\": 123,\n      \"price\": 123,\n      \"id\": \"<string>\",\n      \"itemId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"discountPercentage\": 123,\n      \"discountReason\": \"<string>\",\n      \"soldPackageId\": \"<string>\",\n      \"bankedQuantity\": 123,\n      \"bankedItemId\": \"<string>\",\n      \"issuedDiscountId\": \"<string>\",\n      \"soldByProviderId\": \"<string>\",\n      \"taxAmount\": 123,\n      \"pricingId\": \"<string>\",\n      \"shipmentIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"ruleSetId\": \"<string>\",\n  \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n  \"externalId\": \"<string>\",\n  \"creator\": {\n    \"id\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phoneNumber\": \"<string>\",\n    \"email\": \"<string>\",\n    \"locationId\": \"<string>\"\n  },\n  \"comment\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"tips\": []\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/patient-credit/create")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"total\": 123,\n  \"totalOutstanding\": 123,\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  \"createdDate\": \"2023-11-07T05:31:56Z\",\n  \"adjustments\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"providerId\": \"<string>\",\n      \"locationId\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"payments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"paymentMedium\": \"<string>\",\n      \"refunds\": [\n        {\n          \"id\": \"<string>\",\n          \"amount\": 123,\n          \"createdDate\": \"2023-11-07T05:31:56Z\",\n          \"description\": \"<string>\",\n          \"creator\": {\n            \"id\": \"<string>\",\n            \"firstName\": \"<string>\",\n            \"lastName\": \"<string>\",\n            \"phoneNumber\": \"<string>\",\n            \"email\": \"<string>\",\n            \"locationId\": \"<string>\"\n          }\n        }\n      ],\n      \"paymentMethod\": {\n        \"id\": \"<string>\",\n        \"patientId\": \"<string>\",\n        \"rainforestPaymentMethodId\": \"<string>\",\n        \"brand\": \"<string>\",\n        \"last4\": \"<string>\",\n        \"expMonth\": 123,\n        \"expYear\": 123,\n        \"accountHolderType\": \"<string>\",\n        \"accountNumberLast4\": 123,\n        \"bankName\": \"<string>\",\n        \"routingNumber\": 123,\n        \"description\": \"<string>\",\n        \"isDefault\": false,\n        \"isArchived\": false\n      }\n    }\n  ],\n  \"plannedPayments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"paymentDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"items\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"quantity\": 123,\n      \"price\": 123,\n      \"id\": \"<string>\",\n      \"itemId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"discountPercentage\": 123,\n      \"discountReason\": \"<string>\",\n      \"soldPackageId\": \"<string>\",\n      \"bankedQuantity\": 123,\n      \"bankedItemId\": \"<string>\",\n      \"issuedDiscountId\": \"<string>\",\n      \"soldByProviderId\": \"<string>\",\n      \"taxAmount\": 123,\n      \"pricingId\": \"<string>\",\n      \"shipmentIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"ruleSetId\": \"<string>\",\n  \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n  \"externalId\": \"<string>\",\n  \"creator\": {\n    \"id\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phoneNumber\": \"<string>\",\n    \"email\": \"<string>\",\n    \"locationId\": \"<string>\"\n  },\n  \"comment\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"tips\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/billing/payment/patient-credit/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  \"total\": 123,\n  \"totalOutstanding\": 123,\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  \"createdDate\": \"2023-11-07T05:31:56Z\",\n  \"adjustments\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"providerId\": \"<string>\",\n      \"locationId\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"payments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"paymentMedium\": \"<string>\",\n      \"refunds\": [\n        {\n          \"id\": \"<string>\",\n          \"amount\": 123,\n          \"createdDate\": \"2023-11-07T05:31:56Z\",\n          \"description\": \"<string>\",\n          \"creator\": {\n            \"id\": \"<string>\",\n            \"firstName\": \"<string>\",\n            \"lastName\": \"<string>\",\n            \"phoneNumber\": \"<string>\",\n            \"email\": \"<string>\",\n            \"locationId\": \"<string>\"\n          }\n        }\n      ],\n      \"paymentMethod\": {\n        \"id\": \"<string>\",\n        \"patientId\": \"<string>\",\n        \"rainforestPaymentMethodId\": \"<string>\",\n        \"brand\": \"<string>\",\n        \"last4\": \"<string>\",\n        \"expMonth\": 123,\n        \"expYear\": 123,\n        \"accountHolderType\": \"<string>\",\n        \"accountNumberLast4\": 123,\n        \"bankName\": \"<string>\",\n        \"routingNumber\": 123,\n        \"description\": \"<string>\",\n        \"isDefault\": false,\n        \"isArchived\": false\n      }\n    }\n  ],\n  \"plannedPayments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"paymentDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"items\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"quantity\": 123,\n      \"price\": 123,\n      \"id\": \"<string>\",\n      \"itemId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"discountPercentage\": 123,\n      \"discountReason\": \"<string>\",\n      \"soldPackageId\": \"<string>\",\n      \"bankedQuantity\": 123,\n      \"bankedItemId\": \"<string>\",\n      \"issuedDiscountId\": \"<string>\",\n      \"soldByProviderId\": \"<string>\",\n      \"taxAmount\": 123,\n      \"pricingId\": \"<string>\",\n      \"shipmentIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"ruleSetId\": \"<string>\",\n  \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n  \"externalId\": \"<string>\",\n  \"creator\": {\n    \"id\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phoneNumber\": \"<string>\",\n    \"email\": \"<string>\",\n    \"locationId\": \"<string>\"\n  },\n  \"comment\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"tips\": []\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>"
    }
  ]
}

POST

billing

payment

patient-credit

create

Create Patient Credit Payment

curl --request POST \
  --url https://api.decodahealth.com/billing/payment/patient-credit/create \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "id": "<string>",
  "total": 123,
  "totalOutstanding": 123,
  "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>"
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "adjustments": [
    {
      "chargeId": "<string>",
      "id": "<string>",
      "amount": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "providerId": "<string>",
      "locationId": "<string>",
      "reason": "<string>"
    }
  ],
  "payments": [
    {
      "id": "<string>",
      "amount": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "paymentMedium": "<string>",
      "refunds": [
        {
          "id": "<string>",
          "amount": 123,
          "createdDate": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "creator": {
            "id": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "phoneNumber": "<string>",
            "email": "<string>",
            "locationId": "<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>",
        "isDefault": false,
        "isArchived": false
      }
    }
  ],
  "plannedPayments": [
    {
      "id": "<string>",
      "amount": 123,
      "paymentDate": "2023-11-07T05:31:56Z"
    }
  ],
  "items": [
    {
      "chargeId": "<string>",
      "quantity": 123,
      "price": 123,
      "id": "<string>",
      "itemId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "discountAmount": 123,
      "discountPercentage": 123,
      "discountReason": "<string>",
      "soldPackageId": "<string>",
      "bankedQuantity": 123,
      "bankedItemId": "<string>",
      "issuedDiscountId": "<string>",
      "soldByProviderId": "<string>",
      "taxAmount": 123,
      "pricingId": "<string>",
      "shipmentIds": [
        "<string>"
      ]
    }
  ],
  "description": "<string>",
  "ruleSetId": "<string>",
  "externalCreatedDate": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "creator": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>"
  },
  "comment": "<string>",
  "locationId": "<string>",
  "tips": []
}
'

import requests

url = "https://api.decodahealth.com/billing/payment/patient-credit/create"

payload = {
    "id": "<string>",
    "total": 123,
    "totalOutstanding": 123,
    "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>"
    },
    "createdDate": "2023-11-07T05:31:56Z",
    "adjustments": [
        {
            "chargeId": "<string>",
            "id": "<string>",
            "amount": 123,
            "createdDate": "2023-11-07T05:31:56Z",
            "providerId": "<string>",
            "locationId": "<string>",
            "reason": "<string>"
        }
    ],
    "payments": [
        {
            "id": "<string>",
            "amount": 123,
            "createdDate": "2023-11-07T05:31:56Z",
            "paymentMedium": "<string>",
            "refunds": [
                {
                    "id": "<string>",
                    "amount": 123,
                    "createdDate": "2023-11-07T05:31:56Z",
                    "description": "<string>",
                    "creator": {
                        "id": "<string>",
                        "firstName": "<string>",
                        "lastName": "<string>",
                        "phoneNumber": "<string>",
                        "email": "<string>",
                        "locationId": "<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>",
                "isDefault": False,
                "isArchived": False
            }
        }
    ],
    "plannedPayments": [
        {
            "id": "<string>",
            "amount": 123,
            "paymentDate": "2023-11-07T05:31:56Z"
        }
    ],
    "items": [
        {
            "chargeId": "<string>",
            "quantity": 123,
            "price": 123,
            "id": "<string>",
            "itemId": "<string>",
            "name": "<string>",
            "description": "<string>",
            "discountAmount": 123,
            "discountPercentage": 123,
            "discountReason": "<string>",
            "soldPackageId": "<string>",
            "bankedQuantity": 123,
            "bankedItemId": "<string>",
            "issuedDiscountId": "<string>",
            "soldByProviderId": "<string>",
            "taxAmount": 123,
            "pricingId": "<string>",
            "shipmentIds": ["<string>"]
        }
    ],
    "description": "<string>",
    "ruleSetId": "<string>",
    "externalCreatedDate": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>"
    },
    "comment": "<string>",
    "locationId": "<string>",
    "tips": []
}
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>',
    total: 123,
    totalOutstanding: 123,
    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>'
    },
    createdDate: '2023-11-07T05:31:56Z',
    adjustments: [
      {
        chargeId: '<string>',
        id: '<string>',
        amount: 123,
        createdDate: '2023-11-07T05:31:56Z',
        providerId: '<string>',
        locationId: '<string>',
        reason: '<string>'
      }
    ],
    payments: [
      {
        id: '<string>',
        amount: 123,
        createdDate: '2023-11-07T05:31:56Z',
        paymentMedium: '<string>',
        refunds: [
          {
            id: '<string>',
            amount: 123,
            createdDate: '2023-11-07T05:31:56Z',
            description: '<string>',
            creator: {
              id: '<string>',
              firstName: '<string>',
              lastName: '<string>',
              phoneNumber: '<string>',
              email: '<string>',
              locationId: '<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>',
          isDefault: false,
          isArchived: false
        }
      }
    ],
    plannedPayments: [{id: '<string>', amount: 123, paymentDate: '2023-11-07T05:31:56Z'}],
    items: [
      {
        chargeId: '<string>',
        quantity: 123,
        price: 123,
        id: '<string>',
        itemId: '<string>',
        name: '<string>',
        description: '<string>',
        discountAmount: 123,
        discountPercentage: 123,
        discountReason: '<string>',
        soldPackageId: '<string>',
        bankedQuantity: 123,
        bankedItemId: '<string>',
        issuedDiscountId: '<string>',
        soldByProviderId: '<string>',
        taxAmount: 123,
        pricingId: '<string>',
        shipmentIds: ['<string>']
      }
    ],
    description: '<string>',
    ruleSetId: '<string>',
    externalCreatedDate: '2023-11-07T05:31:56Z',
    externalId: '<string>',
    creator: {
      id: '<string>',
      firstName: '<string>',
      lastName: '<string>',
      phoneNumber: '<string>',
      email: '<string>',
      locationId: '<string>'
    },
    comment: '<string>',
    locationId: '<string>',
    tips: []
  })
};

fetch('https://api.decodahealth.com/billing/payment/patient-credit/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/payment/patient-credit/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>',
    'total' => 123,
    'totalOutstanding' => 123,
    '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>'
    ],
    'createdDate' => '2023-11-07T05:31:56Z',
    'adjustments' => [
        [
                'chargeId' => '<string>',
                'id' => '<string>',
                'amount' => 123,
                'createdDate' => '2023-11-07T05:31:56Z',
                'providerId' => '<string>',
                'locationId' => '<string>',
                'reason' => '<string>'
        ]
    ],
    'payments' => [
        [
                'id' => '<string>',
                'amount' => 123,
                'createdDate' => '2023-11-07T05:31:56Z',
                'paymentMedium' => '<string>',
                'refunds' => [
                                [
                                                                'id' => '<string>',
                                                                'amount' => 123,
                                                                'createdDate' => '2023-11-07T05:31:56Z',
                                                                'description' => '<string>',
                                                                'creator' => [
                                                                                                                                'id' => '<string>',
                                                                                                                                'firstName' => '<string>',
                                                                                                                                'lastName' => '<string>',
                                                                                                                                'phoneNumber' => '<string>',
                                                                                                                                'email' => '<string>',
                                                                                                                                'locationId' => '<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>',
                                'isDefault' => false,
                                'isArchived' => false
                ]
        ]
    ],
    'plannedPayments' => [
        [
                'id' => '<string>',
                'amount' => 123,
                'paymentDate' => '2023-11-07T05:31:56Z'
        ]
    ],
    'items' => [
        [
                'chargeId' => '<string>',
                'quantity' => 123,
                'price' => 123,
                'id' => '<string>',
                'itemId' => '<string>',
                'name' => '<string>',
                'description' => '<string>',
                'discountAmount' => 123,
                'discountPercentage' => 123,
                'discountReason' => '<string>',
                'soldPackageId' => '<string>',
                'bankedQuantity' => 123,
                'bankedItemId' => '<string>',
                'issuedDiscountId' => '<string>',
                'soldByProviderId' => '<string>',
                'taxAmount' => 123,
                'pricingId' => '<string>',
                'shipmentIds' => [
                                '<string>'
                ]
        ]
    ],
    'description' => '<string>',
    'ruleSetId' => '<string>',
    'externalCreatedDate' => '2023-11-07T05:31:56Z',
    'externalId' => '<string>',
    'creator' => [
        'id' => '<string>',
        'firstName' => '<string>',
        'lastName' => '<string>',
        'phoneNumber' => '<string>',
        'email' => '<string>',
        'locationId' => '<string>'
    ],
    'comment' => '<string>',
    'locationId' => '<string>',
    'tips' => [
        
    ]
  ]),
  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/patient-credit/create"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"total\": 123,\n  \"totalOutstanding\": 123,\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  \"createdDate\": \"2023-11-07T05:31:56Z\",\n  \"adjustments\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"providerId\": \"<string>\",\n      \"locationId\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"payments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"paymentMedium\": \"<string>\",\n      \"refunds\": [\n        {\n          \"id\": \"<string>\",\n          \"amount\": 123,\n          \"createdDate\": \"2023-11-07T05:31:56Z\",\n          \"description\": \"<string>\",\n          \"creator\": {\n            \"id\": \"<string>\",\n            \"firstName\": \"<string>\",\n            \"lastName\": \"<string>\",\n            \"phoneNumber\": \"<string>\",\n            \"email\": \"<string>\",\n            \"locationId\": \"<string>\"\n          }\n        }\n      ],\n      \"paymentMethod\": {\n        \"id\": \"<string>\",\n        \"patientId\": \"<string>\",\n        \"rainforestPaymentMethodId\": \"<string>\",\n        \"brand\": \"<string>\",\n        \"last4\": \"<string>\",\n        \"expMonth\": 123,\n        \"expYear\": 123,\n        \"accountHolderType\": \"<string>\",\n        \"accountNumberLast4\": 123,\n        \"bankName\": \"<string>\",\n        \"routingNumber\": 123,\n        \"description\": \"<string>\",\n        \"isDefault\": false,\n        \"isArchived\": false\n      }\n    }\n  ],\n  \"plannedPayments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"paymentDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"items\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"quantity\": 123,\n      \"price\": 123,\n      \"id\": \"<string>\",\n      \"itemId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"discountPercentage\": 123,\n      \"discountReason\": \"<string>\",\n      \"soldPackageId\": \"<string>\",\n      \"bankedQuantity\": 123,\n      \"bankedItemId\": \"<string>\",\n      \"issuedDiscountId\": \"<string>\",\n      \"soldByProviderId\": \"<string>\",\n      \"taxAmount\": 123,\n      \"pricingId\": \"<string>\",\n      \"shipmentIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"ruleSetId\": \"<string>\",\n  \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n  \"externalId\": \"<string>\",\n  \"creator\": {\n    \"id\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phoneNumber\": \"<string>\",\n    \"email\": \"<string>\",\n    \"locationId\": \"<string>\"\n  },\n  \"comment\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"tips\": []\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/patient-credit/create")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"total\": 123,\n  \"totalOutstanding\": 123,\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  \"createdDate\": \"2023-11-07T05:31:56Z\",\n  \"adjustments\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"providerId\": \"<string>\",\n      \"locationId\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"payments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"paymentMedium\": \"<string>\",\n      \"refunds\": [\n        {\n          \"id\": \"<string>\",\n          \"amount\": 123,\n          \"createdDate\": \"2023-11-07T05:31:56Z\",\n          \"description\": \"<string>\",\n          \"creator\": {\n            \"id\": \"<string>\",\n            \"firstName\": \"<string>\",\n            \"lastName\": \"<string>\",\n            \"phoneNumber\": \"<string>\",\n            \"email\": \"<string>\",\n            \"locationId\": \"<string>\"\n          }\n        }\n      ],\n      \"paymentMethod\": {\n        \"id\": \"<string>\",\n        \"patientId\": \"<string>\",\n        \"rainforestPaymentMethodId\": \"<string>\",\n        \"brand\": \"<string>\",\n        \"last4\": \"<string>\",\n        \"expMonth\": 123,\n        \"expYear\": 123,\n        \"accountHolderType\": \"<string>\",\n        \"accountNumberLast4\": 123,\n        \"bankName\": \"<string>\",\n        \"routingNumber\": 123,\n        \"description\": \"<string>\",\n        \"isDefault\": false,\n        \"isArchived\": false\n      }\n    }\n  ],\n  \"plannedPayments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"paymentDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"items\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"quantity\": 123,\n      \"price\": 123,\n      \"id\": \"<string>\",\n      \"itemId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"discountPercentage\": 123,\n      \"discountReason\": \"<string>\",\n      \"soldPackageId\": \"<string>\",\n      \"bankedQuantity\": 123,\n      \"bankedItemId\": \"<string>\",\n      \"issuedDiscountId\": \"<string>\",\n      \"soldByProviderId\": \"<string>\",\n      \"taxAmount\": 123,\n      \"pricingId\": \"<string>\",\n      \"shipmentIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"ruleSetId\": \"<string>\",\n  \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n  \"externalId\": \"<string>\",\n  \"creator\": {\n    \"id\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phoneNumber\": \"<string>\",\n    \"email\": \"<string>\",\n    \"locationId\": \"<string>\"\n  },\n  \"comment\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"tips\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/billing/payment/patient-credit/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  \"total\": 123,\n  \"totalOutstanding\": 123,\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  \"createdDate\": \"2023-11-07T05:31:56Z\",\n  \"adjustments\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"providerId\": \"<string>\",\n      \"locationId\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"payments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"createdDate\": \"2023-11-07T05:31:56Z\",\n      \"paymentMedium\": \"<string>\",\n      \"refunds\": [\n        {\n          \"id\": \"<string>\",\n          \"amount\": 123,\n          \"createdDate\": \"2023-11-07T05:31:56Z\",\n          \"description\": \"<string>\",\n          \"creator\": {\n            \"id\": \"<string>\",\n            \"firstName\": \"<string>\",\n            \"lastName\": \"<string>\",\n            \"phoneNumber\": \"<string>\",\n            \"email\": \"<string>\",\n            \"locationId\": \"<string>\"\n          }\n        }\n      ],\n      \"paymentMethod\": {\n        \"id\": \"<string>\",\n        \"patientId\": \"<string>\",\n        \"rainforestPaymentMethodId\": \"<string>\",\n        \"brand\": \"<string>\",\n        \"last4\": \"<string>\",\n        \"expMonth\": 123,\n        \"expYear\": 123,\n        \"accountHolderType\": \"<string>\",\n        \"accountNumberLast4\": 123,\n        \"bankName\": \"<string>\",\n        \"routingNumber\": 123,\n        \"description\": \"<string>\",\n        \"isDefault\": false,\n        \"isArchived\": false\n      }\n    }\n  ],\n  \"plannedPayments\": [\n    {\n      \"id\": \"<string>\",\n      \"amount\": 123,\n      \"paymentDate\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"items\": [\n    {\n      \"chargeId\": \"<string>\",\n      \"quantity\": 123,\n      \"price\": 123,\n      \"id\": \"<string>\",\n      \"itemId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"discountAmount\": 123,\n      \"discountPercentage\": 123,\n      \"discountReason\": \"<string>\",\n      \"soldPackageId\": \"<string>\",\n      \"bankedQuantity\": 123,\n      \"bankedItemId\": \"<string>\",\n      \"issuedDiscountId\": \"<string>\",\n      \"soldByProviderId\": \"<string>\",\n      \"taxAmount\": 123,\n      \"pricingId\": \"<string>\",\n      \"shipmentIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"ruleSetId\": \"<string>\",\n  \"externalCreatedDate\": \"2023-11-07T05:31:56Z\",\n  \"externalId\": \"<string>\",\n  \"creator\": {\n    \"id\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phoneNumber\": \"<string>\",\n    \"email\": \"<string>\",\n    \"locationId\": \"<string>\"\n  },\n  \"comment\": \"<string>\",\n  \"locationId\": \"<string>\",\n  \"tips\": []\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

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Body

application/json

string

required

total

integer

required

totalOutstanding

integer

required

status

enum<string>

required

Available options:

OUTSTANDING,

PAID,

EXTERNAL_SETTLEMENT,

VOID,

WRITE_OFF,

REFUNDED,

CHARGEBACK,

PAYMENT_PLAN,

COLLECTIONS

patient

PatientSummary · object

required

Show child attributes

createdDate

string<date-time>

required

adjustments

AdjustmentSummary · object[]

required

Show child attributes

payments

ChargeTablePayment · object[]

required

Show child attributes

plannedPayments

ChargeTablePlannedPayment · object[]

required

Show child attributes

items

ChargeItem · object[]

required

Show child attributes

description

string | null

ruleSetId

string | null

externalCreatedDate

string<date-time> | null

externalId

string | null

creator

UserTiny · object | null

Show child attributes

comment

string | null

locationId

string | null

tips

TipDetail · object[]

List of Tips in the Charge.

Show child attributes

Response

Successful Response

string

required

The unique identifier for the payment.

amount

integer

required

The total amount of the payment.

status

enum<string>

required

The current status of the payment.

Available options:

CANCELED,

CREATED,

FAILED,

IN_REVIEW,

PRESENTING,

PROCESSING,

SUCCEEDED

paymentMedium

string

required

The name of the payment medium.

createdDate

string<date-time>

required

The date and time the payment was created.

feeToPatient

integer

required

The fee charged to the patient for the transaction.

patientId

string | null

The ID of the patient associated with the payment.

payinId

string | null

The ID of the payin associated with the payment.

currency

string

default:USD

The currency in which the payment was made.

payinConfigId

string | null

The configuration ID for the payin.

paymentMethodId

string | null

The ID of the payment method used.

stripePaymentIntentId

string | null

Stripe's payment intent ID if used.

failedReason

string | null

Reason for payment failure if applicable.

updatedDate

string<date-time> | null

The date and time the payment was last updated.

fee

integer

default:0

The fee charged by the payment processor.

Create Loyalty Points Payment Create Payin Config Booking Fee

Getting Started

API Guides

Patient Management

Billing & Payments

Catalog & Inventory

Growth

Clinical & Scheduling

Platform

Create Patient Credit Payment

Headers

Body

Response