Skip to main content
POST
/
billing
/
insurance-payment
/
create
Create Insurance Payment
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>"
}
'
{
  "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>"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
id
string
required

Unique identifier for the insurance payment.

insurer
string
required

Name of the insurer.

amount
integer
required

Amount of the payment.

comment
string | null

Optional comment about the payment.

currency
string
default:USD

Currency of the payment.

locationId
string | null

Location of the payment.

creatorId
string | null

ID of the provider who created this payment.

Response

Successful Response

id
string
required

Unique identifier for the insurance payment.

insurer
string
required

Name of the insurer.

amount
integer
required

Amount of the payment.

currency
string
required

Currency of the payment.

status
enum<string>
required

Status of the payment.

Available options:
CANCELED,
CREATED,
FAILED,
IN_REVIEW,
PRESENTING,
PROCESSING,
SUCCEEDED
payinId
string
required

Unique identifier for the payin.

payinConfigId
string
required

Unique identifier for the payin configuration.

paymentMedium
enum<string>
required

Medium of the payment.

Available options:
POS,
VIRTUAL_TERMINAL,
PAYMENT_LINK,
PAYMENT_PLAN,
SUBSCRIPTION,
SAVED_PAYMENT_METHOD,
MEMBERSHIP,
CASH,
CHECK,
CARE_CREDIT,
PATIENT_CREDIT
fee
integer
required

Fee associated with the payment.

createdDate
string<date-time>
required

The date when the payment was created.

comment
string | null

Optional comment about the payment.

paymentMethod
PaymentMethodSummary · object

Summary of the payment method used.

creatorId
string | null

ID of the provider who created this payment.