# Decrease the balance of a specific account with a debit offset

**POST /accounts/{account_id}/line_items/debit_offsets**




## Servers
- Public Sandbox: https://sandbox-api.canopyservicing.com (Public Sandbox)
- Protected UAT Sandbox: https://uat-api.canopyservicing.com (Protected UAT Sandbox)
- Production: https://api.canopyservicing.com (Production)


## Authentication methods
- O auth2


## Parameters

### Path parameters
- **account_id** (string)
  Account ID


### Body: application/json (object)
Body of request to create debit offset.
- **line_item_id** (string)
  The ID associated to be with the line item for future requests. If not provided on line item creation, Canopy will generate this field.
- **original_amount_cents** (integer)
  The payment amount in cents.
- **effective_at** (string(date-time))
  The `Date-Time` that the debit offset is applicable to the account. Although the debit offset is created in Canopy today, it can actually be effective as of a date in the past. This should only be used for data migrations.
- **allocation** (string)
  Optional designation for which balance bucket the credit offset should be allocated to.
- **external_fields** (array[object] | null)
  External fields can be used to relate debit offsets created in Canopy to entities in your or any external system.


## Responses
### 200
Debit offset created

#### Body: application/json (object)
- **account_id** (string)
  The account associated with the line item
- **line_item_id** (string)
  The ID associated with the line item
- **effective_at** (string(date-time))
  The `Date-Time` that this line item became/becomes active
- **created_at** (string(date-time))
  The `Date-Time` which the line item was created.
- **product_id** (string)
  the Product ID of the account
- **line_item_summary** (object)

- **merchant_data** (object | null)
  Merchant information if applicable.
- **issuer_processor_details** (object | null)

- **external_fields** (array[object] | null)
  An array of static references to fields in a third party system.
- **line_item_overview** (object)


### 401
Unauthorized.

### 403
Forbidden.

### 422
Invalid input

### 429
Too many requests.

### default
Unexpected Error.


[Powered by Bump.sh](https://bump.sh)