Capture a written Reg Z billing-error notice and protect disputed amounts
POST
/facilities/{id}/billing-errorsPath parameters
idstringRequiredHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
amountsobjectRequired3 child attributes
fees_amountintegerRequiredinterest_amountintegerRequiredprincipal_amountintegerRequiredchannelstringRequireddraw_idstringRequiredkindstringRequiredperiodstringRequiredreasonstringRequiredreceived_atstring · date-timeRequiredreferencestringRequiredsha256stringRequiredReturns
200 OK
acknowledgment_duestring · dateRequiredA business date, YYYY-MM-DD
created_atstring · date-timeRequiredcreated_bystringRequiredcustomer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
facility_idstringRequiredidstringRequiredinterest_reviewobjectRequired11 child attributes
accrued_at_intakestringRequiredlast_accruedstring · date or nullOptionalA business date, YYYY-MM-DD
overlapping_accrual_rowsintegerRequiredoverlapping_accrual_totalstringRequiredoverlapping_paid_amountintegerRequiredoverlapping_payment_rowsintegerRequiredoverlapping_pending_recognition_rowsintegerRequiredoverlapping_recognition_rowsintegerRequiredoverlapping_recognized_amountintegerRequiredrecognized_interest_at_intakeintegerRequiredrequiredbooleanRequiredpolicyobjectRequired10 child attributes
cycle_close_dayintegerRequiredexpense_gl_codestringRequiredidstringRequiredinterest_refund_roundingstringOptionalinterest_refund_routestringOptionalmax_claim_amountintegerRequiredproduct_codesarray of stringsRequiredresumption_grace_daysintegerRequiredsuspend_all_interestbooleanRequiredtimezonestringRequiredrequestobjectRequired9 child attributes
amountsobjectRequired3 child attributes
fees_amountintegerRequiredinterest_amountintegerRequiredprincipal_amountintegerRequiredchannelstringRequireddraw_idstringRequiredkindstringRequiredperiodstringRequiredreasonstringRequiredreceived_atstring · date-timeRequiredreferencestringRequiredsha256stringRequiredresolution_duestring · dateRequiredA business date, YYYY-MM-DD
stateobjectRequired12 child attributes
acknowledged_atstring · date-time or nullOptionalcorrectedobjectRequired3 child attributes
fees_amountintegerRequiredinterest_amountintegerRequiredprincipal_amountintegerRequiredinterest_correction_noticed_atstring · date-time or nullOptionalinterest_reconciled_atstring · date-time or nullOptionalinterest_reconciliation_requiredbooleanRequirednoticed_atstring · date-time or nullOptionaloutcomestringOptionalpending_resolution_idstringOptionalreleased_atstring · date-time or nullOptionalresolved_atstring · date-time or nullOptionalresume_afterstring · date or nullOptionalA business date, YYYY-MM-DD
statusstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503