payments
array[object]
required
List of payments in an account id
string
required
Identification for a single payment description
string
required
Brief description for a payment total_amount_due
string
required
Total loan amount due balance - amount due on monthly statement (for upcoming credit card payments this parameter is shown on UI as Remaining Statement Balance) currency
string
required
The currency where the payment is due due_at
string<date>
required
The date when the payment will be due status
string
required
Allowed values:
OPEN
CLOSED
UNDEFINED
PENDING
PAID
PAST_DUE
UPCOMING
account_id
string
required
Bank account minimum_payment_due
string
required
Minimum Payment amount due_fees_amount
string
Fees charged for a past due pending payment. type
string
required
Allowed values:
PERSONAL_LOAN
MORTGAGE_LOAN
AUTO_LOAN
OTHER_LOAN
CREDITCARD_BALANCE
HOME_EQUITY_LOAN
BUSINESS_LOAN
STUDENT_LOAN
BUSINESS_CREDIT_CARD
STUDENT_CREDIT_CARD
PERSONAL_CREDIT_CARD
CREDIT_CARD
custom_type
string
Payment type customized by bank client custom_status
string
Payment status customized by bank client amount_details
object
principal_payment
string
Principal payment (detail amount of total_amount_due) interest_payment
string
Interest payment (detail amount of total_amount_due) monthly_escrow_payment
string
Monthly escrow payment (detail amount of total_amount_due) fee
string
Fee payment (detail amount of total_amount_due) | 