Create a manual fee for a specific account
Path parameters
-
account_id
string Required Account ID
Body
Required
Body of request to create manual fee.
-
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.
Format should match the following pattern:
^(?!can_).*$
. -
original_amount_cents
integer Required The payment amount in cents.
Default value is
0
. -
effective_at
string(date-time) The
Date-Time
that the fee is applicable to the account. Although the fee 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. -
external_fields
array[object] | null External fields can be used to relate fees created in Canopy to entities in your or any external system.
Not more than
100
elements.
POST
/accounts/{account_id}/line_items/manual_fees
curl \
-X POST https://sandbox-api.canopyservicing.com/accounts/31mNprzLd2bKl6koVna68ARM/line_items/manual_fees \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"line_item_id":"li_0x1234","original_amount_cents":200,"effective_at":"2020-07-20T09:11:28+00:00","external_fields":[{"key":"Globex Card Processing Account ID","value":"22445702-a389-431f-927d-07b8d0750787"}]}'
Request example
{
"line_item_id": "li_0x1234",
"original_amount_cents": 200,
"effective_at": "2020-07-20T09:11:28+00:00",
"external_fields": [
{
"key": "Globex Card Processing Account ID",
"value": "22445702-a389-431f-927d-07b8d0750787"
}
]
}
Request examples
{
"line_item_id": "li_0x1234",
"original_amount_cents": 200,
"effective_at": "2020-07-20T09:11:28+00:00",
"external_fields": [
{
"key": "Globex Card Processing Account ID",
"value": "22445702-a389-431f-927d-07b8d0750787"
}
]
}
Response examples (200)
{
"account_id": 4,
"line_item_id": 2,
"effective_at": "2018-07-20T09:12:30+00:00",
"created_at": "2018-06-20T09:12:30+00:00",
"product_id": 1,
"line_item_summary": {
"original_amount_cents": 2484,
"balance_cents": 3600,
"principal_cents": 2400,
"interest_balance_cents": 1100,
"am_interest_balance_cents": 0,
"deferred_interest_balance_cents": 200,
"am_deferred_interest_balance_cents": 0,
"total_interest_paid_to_date_cents": -16
},
"merchant_data": {
"name": "string",
"id": "string",
"mcc_code": 42.0,
"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"
}
],
"line_item_overview": {
"line_item_status": "VALID",
"line_item_type": "MANUAL_FEE",
"description": "Manual fee against the account"
}
}
Response examples (200)
{
"account_id": 4,
"line_item_id": 2,
"effective_at": "2018-07-20T09:12:30+00:00",
"created_at": "2018-06-20T09:12:30+00:00",
"product_id": 1,
"line_item_summary": {
"original_amount_cents": 2484,
"balance_cents": 3600,
"principal_cents": 2400,
"interest_balance_cents": 1100,
"am_interest_balance_cents": 0,
"deferred_interest_balance_cents": 200,
"am_deferred_interest_balance_cents": 0,
"total_interest_paid_to_date_cents": -16
},
"merchant_data": {
"name": "string",
"id": "string",
"mcc_code": 42.0,
"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"
}
],
"line_item_overview": {
"line_item_status": "VALID",
"line_item_type": "MANUAL_FEE",
"description": "Manual fee against the account"
}
}