The Payment History object

PaymentHistory rebuilds an account's payment-and-fee sequence from retained journals and fee corrections, tied to the ledger's own running balance.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

closing_amountintegerRequired

correctionsarray of objectsRequired

10 child attributes

actorstringRequired

applicationobject or nullOptional

FeeCorrectionApplication is the posted balanced ledger correction.

3 child attributes

actorstringRequired

atstring · date-timeRequired

correction_journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

content_sha256stringRequired

correction_minorintegerRequired

created_atstring · date-timeRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decisionobject or nullOptional

5 child attributes

actorstringRequired

atstring · date-timeRequired

content_sha256stringRequired

decisionstringRequired

reasonstringRequired

feeobjectRequired

AssessedFee is the retained fee the correction acts on.

6 child attributes

amount_minorintegerRequired

currency_codestringRequired

effective_datestring · dateRequired

A business date, YYYY-MM-DD

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

source_refstringRequired

idstringRequired

requestobjectRequired

FeeCorrectionRequest is a maker's proposal to reverse or adjust a fee the payments service assessed. The amount refunded is read from the retained fee journal, never from the request.

5 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

fee_journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

methodstringRequired

reasonstringRequired

target_fee_minorintegerOptional

currency_codestringRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

eventsarray of objectsRequired

11 child attributes

amountintegerRequired

categorystringRequired

committed_atstring · date-timeRequired

correction_idstringOptional

currency_codestringRequired

directionstringRequired

effective_datestring · dateRequired

A business date, YYYY-MM-DD

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

running_amountintegerRequired

source_refstringRequired

fees_assessed_amountintegerRequired

fees_corrected_amountintegerRequired

fromstring · date or nullOptional

A business date, YYYY-MM-DD

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

opening_amountintegerRequired

throughstring · date or nullOptional

A business date, YYYY-MM-DD

ties_to_ledgerbooleanRequired