URL Expired

The URL for this request expired after 30 days.

Account Details

account_id
string
required
ID of the Account

Body of request to create debit offset.

line_item_id
string
^(?!can_).*$
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
required
Defaults to 0
The payment amount in cents.

effective_at
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
enum
Optional designation for which balance bucket the debit offset should be allocated to.

Allowed:
INTEREST,DEFERRED_INTEREST,PRINCIPAL,FEE

external_fields
array,null | object,null

allocation_line_item_id
string
The ID of the Line Item to be prioritized by the debit offset. This ID corresponds to the Line Item that is targeted first by the debit offset, including all related Line Items that were generated as a result of this line item, such as installment interest and amortized fees.

Add Field

Responses

200 Debit offset created 401 Unauthorized. 403 Forbidden. 422 Invalid input 429 Too many requests. default Unexpected Error.

Updated about 1 year ago

Example Request

curl --request POST \
     --url https://contact/sales/to/enable/your/sandbox/accounts/{account_id}/line_items/debit_offsets \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "original_amount_cents": 0\n}\n'  

Click Try It! to start a request and see the response here! Or choose an example:

Response Format
application/json