LElead
User Credit Balance

Close a Credit Balance

Changed on

Close an active or inactive User Credit Balance. Closing is terminal. Outstanding principal, interest, and fees must all be zero first, unless the User Credit Balance is charged off. Calling this on a closed User Credit Balance returns 200 with its current state.

post/v2/user_credit_balances/{user_credit_balance_id}/close

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id}/close
  • Auth
    HTTP bearer

Path parameters

user_credit_balance_idstring required

The Credit Balance's ID

Headers

Idempotency-Keystring required

Idempotency key

Request body

status_reason'entity_closed' | 'client_closed' | 'paid_off' | 'charged_off' | 'canceled' required

Response

Credit Balance closed successfully (or already closed)

idstring
user_account_idstring

The parent User Account's ID.

namestring

Human-readable name.

status'active' | 'inactive' | 'closed' | 'reporting_stopped'
status_reason'active' | 'frozen' | 'dormant' | 'other' | 'entity_closed' | 'client_closed' | 'paid_off' | 'charged_off' | 'canceled' | 'receivables_sold_to_partner' | 'data_not_available'
currency_code'USD'

A three-letter currency code as defined in ISO 4217.

amountinteger

Signed, minor units.

amount_in_usdinteger

Signed, minor units, in USD.

autopay_method'ach' | 'debit_card' | 'wire' | 'virtual_wallet' | 'credit_card' | 'none'
metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

created_atstring date-time
updated_atstring date-time
closed_atstring date-time nullable

Example response

{
  "name": "Personal Loan - Jane Smith",
  "currency_code": "USD",
  "interest": {
    "rate": "5.250000",
    "effective_rate": "5.250000",
    "effective_apr": "5.250"
  }
}

Changes