Create Note

post

https://api.cloud.mbanq.com/v1/{resourceType}/{resourceId}/notes

Use this API to add a new note to a specific resource such as a customer, account, or loan.

You must specify the resourceType, resourceId, and provide the content of the note in the request body.

Behaviour: A successful response indicates that the note was successfully created and associated with the specified resource.

Path Params

resourceType

string

enum

required

The type of the resource.
Example: clients

Allowed:

resourceId

integer

required

Defaults to 1234

The Identifier of the specific resource.
Example: 1234

Query Params

action

string

enum

required

The action command for this request.
Example: clients

Body Params

The table below outlines the parameters used for performing note actions on different resource types.
To use this API, you need to provide the resourceType and resourceId, which can be obtained from the below table.

Parameter	Description	Mandatory	Data Type	Example
resourceType	Type of the resource on which the note is being added.	Yes	String	clients
resourceId	Unique identifier of the resource.	Yes	String	1023
action	The specific action performed on the resource.	Yes	String	approve

Supported actions vary based on the resource type. The table below lists the supported entities, their corresponding resource types, valid actions, and associated codes:

Entity	Resource Type	Action	Description	Code
CUSTOMER	clients	update	Update customer information	101
CUSTOMER	clients	delete	Delete a customer	102
CUSTOMER	clients	approve	Approve customer onboarding or update	103
CUSTOMER	clients	reject	Reject customer details	104
CUSTOMER	clients	review	Review customer information	106
CUSTOMER	clients	verify	Verify customer KYC	107
CUSTOMER	clients	ofac.check	Perform OFAC check on the customer	107
SAVINGS_ACCOUNT	savingsaccount	review	Review savings account	106
SAVINGS_ACCOUNT	savingsaccount	block	Block the entire savings account	110
SAVINGS_ACCOUNT	savingsaccount	blockAmount	Block a specific amount in the account	120
SAVINGS_ACCOUNT	savingsaccount	close	Close the savings account	118
SAVINGS_ACCOUNT	savingsaccount	suspend	Temporarily suspend account operations	105
SAVINGS_ACCOUNT	savingsaccount	unblock	Unblock the account	111
SAVINGS_ACCOUNT	savingsaccount	block.debit	Block debit transactions	112
SAVINGS_ACCOUNT	savingsaccount	unblock.debit	Unblock debit transactions	113
SAVINGS_ACCOUNT	savingsaccount	block.credit	Block credit transactions	114
SAVINGS_ACCOUNT	savingsaccount	unblock.credit	Unblock credit transactions	115
SAVINGS_ACCOUNT	savingsaccount	hold.amount	Hold a specific amount	120
SAVINGS_ACCOUNT	savingsaccount	release.amount	Release held amount	121
SAVINGS_ACCOUNT	savingsaccount	withdraw	Withdraw from the account	122
SAVINGS_TRANSACTION	savingsTransactions	review	Review a savings transaction	106
LOAN	loans	update	Update loan details	101
LOAN	loans	approve	Approve a loan	103
LOAN	loans	reject	Reject a loan application	104
LOAN	loans	review	Review loan details	106
LOAN	loans	waive	Waive loan charges	116
LOAN	loans	writeoff	Write off the loan	117
LOAN	loans	preclose	Pre-close the loan	119
LOAN_TRANSACTION	loanTransactions	review	Review a loan transaction	106
CARD_AUTHORIZATION	cardauthorization	review	Review card authorization	106

note

string

required

Defaults to Hello world note

The note for the dispute.
Example: Hello world note

Headers

tenantId

string

required

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

Response

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200The Note is created successfully.