The Credit Repayment object 

Attributes

• idstring

  Unique identifier for the object.

• accountstring

  The connected account making the repayment.

• amount_allocationnullable object

  A breakdown indicating how the amount is allocated to principal, interest, and fees. This field is available once the repayment is processing.

  Hide child attributes

  • amount_allocation.fees_amountinteger

    The portion of amount applied to fees.

  • amount_allocation.interest_amountinteger

    The portion of amount applied to interest.

  • amount_allocation.principal_amountinteger

    The portion of amount applied to the principal.

• payment_recordstringExpandable

  The payment record for the repayment.

• statusenum

  The current status of the repayment.

  Possible enum values

  canceled The repayment was canceled by the platform.

  created The repayment is newly-created and not yet processing.

  failed The payment has failed. To retry, create a new repayment.

  processing The payment is processing.

  succeeded The payment has succeeded.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• balance_transactionnullable stringExpandable

  The balance transaction that describes the impact of this repayment on your account balance.

• credit_ledger_entriesarray of objects

  The credit ledger entries for the repayment.

• credit_statement_descriptornullable string

  Statement descriptor to be shown on the cardholder’s credit statement for this repayment.

• failure_balance_transactionnullable stringExpandable

  The balance transaction that describes the reversal of the balance on your account due to repayment failure.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.