Update an existing line item

PUT /accounts/{account_id}/line_items/{line_item_id}

Path parameters

Body

Edit a specific line item.

  • line_item_status string

    The new status which you would like to set for the line item

    Values are VALID, INVALID, OFFSET, PENDING, AUTHORIZED, DECLINED, VOID, or POSTED. Default value is VALID.

  • original_amount_cents integer

    The updated amount (in cents).

Responses

  • • 200 object

    Line Item Edited

    • account_id string Required

      The account associated with the line item

    • line_item_id string Required

      The ID associated with the line item

    • effective_at string(date-time)

      The Date-Time that this line item became/becomes active.

    • valid_at string(date-time)

      The Date-Time that this line item became valid.

    • created_at string(date-time)

      The Date-Time which the line item was created.

    • updated_at string(date-time)

      The Date-Time which the line item was updated.

    • product_id string Required

      the Product ID of the account

    • line_item_overview object
      • line_item_status string

        the corresponding Status for a line item

        Values are AUTHORIZED, DECLINED, INVALID, OFFSET, PENDING, POSTED, REFINANCED, PROCESSING, RETRO_VALID, REVERSED, ROLLED, SETTLED, SPLIT_INVALID, SPLIT_VALID, VALID, or VOID. Default value is VALID.

      • line_item_type string Required

        The Line Item Type. i.e. CHARGE, PAYMENT, CREDIT_OFFSET, DEBIT_OFFSET, MANUAL_FEE.

      • description string | null

        A description of this particular line item if any. More common for adjustments.

      • allocation string | null

        Optional designation for which balance bucket an offset was allocated to. Only applicable to CREDIT_OFFSET and DEBIT_OFFSET type line_items.

        Values are INTEREST, DEFERRED_INTEREST, PRINCIPAL, FEE, or null.

    • line_item_summary object
      • original_amount_cents integer

        The originating amount of money (in cents) relating to this line item.

      • balance_cents integer

        The current balance of the line item, which accounts for interest accrued per the product's interest policy and the account's interest rate attribute.

      • principal_cents integer

        The principal balance of the line item.

      • interest_percent number | null

        Annual interest in percentage.

        Default value is 0.

      • interest_balance_cents integer

        The current interest balance of the line item.

      • am_interest_balance_cents integer

        The current AM interest balance of the line item. Canopy tracks interest during an amortization period separately from deferred interest accrued during a revolving period.

      • deferred_interest_balance_cents integer

        The current deferred interest balance of the line item.

      • am_deferred_interest_balance_cents integer

        The current AM deferred interest balance of the line item. Canopy tracks deferred interest during an amortization period separately from deferred interest accrued during a revolving period.

      • am_fees_balance_cents integer

        The current AM fees balance of the line item.

      • total_interest_paid_to_date_cents integer

        The sum (in cents) of all payments towards interest charges, if any, applied to this line item to date

    • merchant_data object | null

      Merchant information if applicable.

    • issuer_processor_details object | null
      • lithic object
        • last_four string | null

          Last four digits of the card against which the spend was made.

        • transaction_token string(uuid) | null

          The external unique identifier of the transaction.

        • card_token string(uuid) | null

          The external unique identifier of the card related to this line item.

    • external_fields array[object] | null

      An array of static references to fields in a third party system.

      Not more than 1000 elements.

      • key string

        Key - i.e. Name of the External Party

      • value string

        Value - i.e. External Account ID

    • Additional properties are allowed
  • • 401

    Unauthorized.

  • • 403

    Forbidden.

  • • 422

    Invalid input

  • • 429

    Too many requests.

  • • default

    Unexpected Error.

PUT /accounts/{account_id}/line_items/{line_item_id} 
curl \
 -X PUT https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/line_items/can_52322 \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"line_item_status":"VALID","original_amount_cents":200}'
Request example 
{
  "line_item_status": "VALID",
  "original_amount_cents": 200
}
Response example (200) 
{
  "account_id": 4,
  "line_item_id": 2,
  "effective_at": "2018-07-20T09:12:30+00:00",
  "valid_at": "2022-09-30T09:12:30+00:00",
  "created_at": "2018-06-20T09:12:30+00:00",
  "updated_at": "2019-07-21T10:13:31+00:00",
  "product_id": "li_4Yxb5",
  "line_item_overview": {
    "line_item_status": "VALID",
    "line_item_type": "CHARGE",
    "description": "Refund for invalid purchase",
    "allocation": "INTEREST"
  },
  "line_item_summary": {
    "original_amount_cents": 2484,
    "balance_cents": 3600,
    "principal_cents": 2400,
    "interest_percent": 2.34,
    "interest_balance_cents": 1100,
    "am_interest_balance_cents": 0,
    "deferred_interest_balance_cents": 200,
    "am_deferred_interest_balance_cents": 0,
    "am_fees_balance_cents": 0,
    "total_interest_paid_to_date_cents": -16
  },
  "merchant_data": {
    "name": "string",
    "id": "string",
    "mcc_code": "string",
    "phone_number": "string"
  },
  "issuer_processor_details": {
    "lithic": {
      "last_four": 3324,
      "transaction_token": "33xd08bc-d100-488y-bb93-f8a1f081ff0e",
      "card_token": "c6cd08bc-c524-48f5-b64d-f79ec0810df4"
    }
  },
  "external_fields": [
    {
      "key": "Globex Card Processing Account ID",
      "value": "22445702-a389-431f-927d-07b8d0750787"
    }
  ]
}