API Reference

Create Charge

post
https://api.cloud.mbanq.com/v1/charge

Define a new charge that can later be associated with loans and accounts through their respective product definitions or directly on each account instance.

This endpoint allows you to create various types of charges with different calculation methods, application targets, and timing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 100

The name of the charge.

integer
enum
required

Specifies the direction of payment for which direction this charge should apply on Available options:

  • 0: INVALID - Invalid charge time type
  • 1: DISBURSEMENT - Only for loan charges
string
required
length between 3 and 3

A three letter ISO code of currency.

string

The locale for the date formats.

double
required
> 0

The charge amount. Must be a positive number.

integer
enum
required

Specifies when the charge is applied. Use the numeric value corresponding to the desired charge time type. Available options:

  • 0: INVALID - Invalid charge time type
  • 1: DISBURSEMENT - Only for loan charges
  • 2: SPECIFIED_DUE_DATE - For loan and savings charges
  • 3: SAVINGS_ACTIVATION - Only for savings charges
  • 4: SAVINGS_CLOSURE - Only for savings charges
  • 5: WITHDRAWAL_FEE - Only for savings charges
  • 6: ANNUAL_FEE - Only for savings charges
  • 7: MONTHLY_FEE - Only for savings charges
  • 8: INSTALMENT_FEE - Only for loan charges
  • 9: OVERDUE_INSTALLMENT - Only for loan charges
  • 10: OVERDRAFT_FEE - Only for savings charges
  • 11: WEEKLY_FEE - Only for savings charges
  • 12: TRANCHE_DISBURSEMENT - Only for loan charges
  • 13: SHAREACCOUNT_ACTIVATION - Only for share account charges
  • 14: SHARE_PURCHASE - For share purchase charges
  • 15: SHARE_REDEEM - For share redemption charges
  • 16: SAVINGS_NOACTIVITY_FEE - For savings no activity fees
  • 21: DOMESTIC_ATM_WITHDRAWAL_FEE - For domestic ATM withdrawal fees
  • 22: INTERNATIONAL_ATM_WITHDRAWAL_FEE - For international ATM withdrawal fees
  • 23: INTERNATIONAL_TRANSACTIONS_FEE - For international transaction fees
  • 24: EXTERNAL_CARD_PUSH_TRANSACTION_FEE - For external card push transaction fees
  • 25: EXTERNAL_CARD_PULL_TRANSACTION_FEE - For external card pull transaction fees
  • 26: TRANSFER_EXECUTE - For transfer execution fees
  • 27: SAVINGS_DORMANT_FEE - For savings dormant fees
  • 28: SAVINGS_ESCHEAT_FEE - For savings escheat fees
  • 29: SPECIFIED_MCC_FEE - For specified MCC fees
  • 30: CARD_ORDERING_FEE - For card ordering fees
  • 31: CARD_RE_ORDERING_FEE - For card re-ordering fees
  • 32: TRANSFER_RETURN - For transfer return fees
  • 33: LATE_PAYMENT_FEE - For late payment fees
  • 34: RETURN_PAYMENT_FEE - For return payment fees
  • 35: OVER_CREDIT_LIMIT_FEE - For over credit limit fees
  • 36: STOP_PAYMENT_FEE - For stop payment fees
  • 37: JOINING_FEE - For joining fees
  • 38: DIRECT_DEPOSIT_CASH_ADVANCE_FEE - For direct deposit cash advance fees
integer
enum
required

Specifies how the charge is calculated. Use the numeric value corresponding to the desired calculation type. Available options:

  • 0: INVALID - Invalid charge calculation type
  • 1: FLAT - Flat fee
  • 2: PERCENT_OF_AMOUNT - Percentage of amount
  • 3: PERCENT_OF_AMOUNT_AND_INTEREST - Percentage of amount and interest
  • 4: PERCENT_OF_INTEREST - Percentage of interest
  • 5: PERCENT_OF_DISBURSEMENT_AMOUNT - Percentage of disbursement amount
  • 6: PERCENT_OF_MIN_DUE_AMOUNT - Percentage of minimum due amount
  • 7: PERCENT_OF_OUTSTANDING_AMOUNT - Percentage of outstanding amount
integer
enum

Specifies the mode of charge payment. Use the numeric value corresponding to the desired payment mode. Available options:

  • 0: REGULAR - Regular payment mode
  • 1: ACCOUNT_TRANSFER - Account transfer payment mode
Allowed:
boolean

Whether this charge is a penalty.

boolean

Whether the charge is currently active.

double
> 0

Minimum cap for percentage-based charges. Must be a positive number if provided.

double
> 0

Maximum cap for percentage-based Charges.

string

Specifies the day of the month for recurring fees.

integer
≥ 1

Interval for recurring fees. Must be greater than zero if provided.

string

Format for the month and day.

integer
0 to 3

Frequency of the fee application. Must be between 0 and 3 inclusive if provided. Used for indicating the recurring(days,weeks,months and Years) charge due date starting on system calculated date for overdue penalty.

integer
≥ 1

ID of the income account associated with this charge. Required for client charges.

integer
≥ 1

ID of the tax group associated with this charge. Must be greater than zero if provided.

boolean

Whether to ignore charges when the account balance is negative.

boolean

Whether to apply this charge to existing accounts. ( existing accounts created from products in productIDs field )

productIDs
array of integers

IDs from saving products example [1,2,3] so this charge will applying auto to that saving product.

productIDs
integer

Specifies the payment rail for this charge.

string
enum

Specifies the direction of the transfer. For internal transfer there is no in / out direction. Available options:

  • IN: incoming transfer
  • OUT: outgoing transfer
Allowed:
string
enum

Specifies the type of transfer for this charge. Available options:

  • CREDIT: credit transfer
  • DEBIT: debit transfer
Allowed:
integer
≥ 1

ID of the client classification for this charge. Must be greater than zero if provided.

boolean

Whether to apply this charge upfront.

boolean
integer
≥ 0

Number of exempted fees for this charge.

number
≥ 0

Amount of exempted fee for this charge.

boolean

Whether to reverse the charge if the transfer fails.

boolean

Whether the charge is due on account activation.

Headers
string
required
Defaults to z01j3e71zd6zkq908vyf5861a8

The ID of your banking instance visible in the MBANQ Console.

Response

Updated over 1 year ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?