Get insurance payment

Beta
GET
/api/insurance-payments/v1/:insurance_payment_id

Retrieves a previously created insurance payment by its insurance_payment_id. If the payment does not exist, a 403 will be thrown.

Path parameters

insurance_payment_idUUIDRequired

Response

This endpoint returns an object.
insurance_payment_idUUID
payerobject
amount_centsinteger
allocationslist of objects
payment_timestampdatetimeOptional
payment_notestringOptional

Errors

Built with