Skip to content
Interest Sharing On Financing

Edit Financing Interest Config

Create and edit operations share this endpoint. They are distinguished by action_in and whether id is included. This operation changes live billing configuration.

Request parameters

  • Required: action_in (Action Type), currency (Currency), standard_financing_rate (Standard Financing Rate), min_interest_spread (Minimum Interest Spread), year_fee_days (Annual Fee Rate Days), rounding_method (Rounding Method), rounding_decimals (Rounding Decimals), begin_month (Begin Month (Effective)), end_month (End Month (Effective))
  • Optional: id (Config ID)
  • See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

POSThttps://b-api.lbkrs.com/ob_file/edit_financing_interest_config

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

settlement.financing_interest_allocation_config

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

idnumber

Included only when editing an existing record; not passed on creation.

action_instringrequired

Enum values: 1 = create, 2 = edit, 3 = delete; send 2 when a record id is present, otherwise 1.

Values
1
Add
2
Edit
3
Delete
currencystringrequired

A three-letter currency code. Read-only when editing an existing record.

Values
USD
USD
HKD
HKD
SGD
SGD
CNY
CNY
AUD
AUD
JPY
JPY
GBP
GBP
EUR
EUR
CAD
CAD
MYR
MYR
AMD
AMD
BGN
BGN
BTN
BTN
BWP
BWP
BZD
BZD
CDF
CDF
CHF
CHF
DKK
DKK
GHS
GHS
GMD
GMD
GNF
GNF
HRK
HRK
HUF
HUF
ILS
ILS
INR
INR
IQD
IQD
IRR
IRR
ISK
ISK
LRD
LRD
LYD
LYD
MOP
MOP
RUB
RUB
UAH
UAH
UGX
UGX
UYI
UYI
UYU
UYU
UZS
UZS
XAF
XAF
XOF
XOF
XSU
XSU
YER
YER
IDR
IDR
TWD
TWD
THB
THB
KRW
KRW
NZD
NZD
standard_financing_ratestringrequired

A percentage value; the client validates the range > 0 and ≤ 9999, with at most 10 decimal places.

min_interest_spreadstringrequired

A percentage value; validated with the same rules as standard_financing_rate.

year_fee_daysnumberrequired

Enum comes from ref settlement_year_fee_days; submitted as a number.

Allowed values: 360, 365, 366

Values
360
360
365
365
366
366
rounding_methodnumberrequired

Rounding method.

Values
1
Round
2
Round Up
3
Round Down
rounding_decimalsnumberrequired

Number of decimal places to retain, submitted as a number.

Values
0
0
1
1
2
2
3
3
begin_monthstringrequired

Format YYYYMM, generated by splitting the caller "validity period" month-range picker.

end_monthstringrequired

Format YYYYMM, generated by splitting the caller "validity period" month-range picker.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs