Insurance PaymentsV1

Create insurance payment

Beta
POST

Creates a new insurance payment record and returns the newly created InsurancePayment object. This endpoint should only be used for insurance payments that do not have a corresponding ERA (for example: a settlement check from a payer). If the payment is an ERA, then you should used the insurance-adjudications API.

Request

This endpoint expects an object.
payer_identifier
unionRequired
amount_cents
integerRequired
allocations
list of objectsRequired
Allocations are portions of payments that are applied to specific resources, known as targets. Each allocation has and amount, defined in cents, and a target.
payment_timestamp
datetimeOptional
payment_note
stringOptional

Response

This endpoint returns an object
insurance_payment_id
UUID
payer
object
amount_cents
integer
allocations
list of objects
payment_timestamp
datetimeOptional
payment_note
stringOptional

Errors

Built with