Create Note

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

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

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

resource_Type

string

required

Defaults to client

The type of the resource. Example: client

resourceId

string

required

Defaults to 1234

The Identifier of the specific resource. Example: 1234

Query Params

action

string

required

Defaults to client

The action command for this request. Example: client

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	client
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
CLIENT	client	update	Update client information	101
CLIENT	client	delete	Delete a client	102
CLIENT	client	approve	Approve client onboarding or update	103
CLIENT	client	reject	Reject client details	104
CLIENT	client	review	Review client information	106
CLIENT	client	verify	Verify client KYC	107
CLIENT	client	ofac.check	Perform OFAC check on the client	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	savingstransaction	review	Review a savings transaction	106
LOAN	loan	update	Update loan details	101
LOAN	loan	approve	Approve a loan	103
LOAN	loan	reject	Reject a loan application	104
LOAN	loan	review	Review loan details	106
LOAN	loan	waive	Waive loan charges	116
LOAN	loan	writeoff	Write off the loan	117
LOAN	loan	preclose	Pre-close the loan	119
LOAN_TRANSACTION	loantransaction	review	Review a loan transaction	106
GROUP	group	[Unused]	No supported actions currently
DEBIT_CARD	debitcard	review	Review debit card details	106
DEBIT_CARD	debitcard	activate	Activate the debit card	108
DEBIT_CARD	debitcard	deactivate	Deactivate the debit card	109
DEBIT_CARD	debitcard	block	Permanently block the debit card	110
DEBIT_CARD	debitcard	unblock	Unblock the debit card	111
DEBIT_CARD	debitcard	hotlist	Hotlist the debit card	123
DEBIT_CARD	debitcard	temporarily.block	Temporarily block the debit card	124
DEBIT_CARD	debitcard	temporarily.unblock	Unblock a temporarily blocked debit card	125
CREDIT_CARD	creditcard	review	Review credit card details	106
CREDIT_CARD	creditcard	suspend	Suspend the credit card temporarily	105
CREDIT_CARD	creditcard	block	Permanently block the credit card	110
CREDIT_CARD	creditcard	unblock	Unblock the credit card	111
CARD_AUTHORIZATION	cardauthorization	review	Review card authorization	106
SHARE_ACCOUNT	shareaccount	review	Review share account details	106
DISPUTE	dispute	review	Review dispute details	106
DISPUTE	dispute	approve	Approve the dispute	103
DISPUTE	dispute	reject	Reject the dispute	104
DISPUTE	dispute	adjust	Adjust the dispute transaction	123
COMPLIANCE_REVIEW	compliancereview	review	Review compliance-related documents	106
COMPLIANCE_REVIEW	compliancereview	approve	Approve the compliance review	103
COMPLIANCE_REVIEW	compliancereview	reject	Reject the compliance review	104

note

string

required

Defaults to Hello world note

The note for the dispute. Example: Hello world note

Headers

tenantId

string

required

Defaults to z01j3e71zd6zkq908vyf5861a8

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

Response

Language

Credentials

Bearer

JWT


xxxxxxxxxx
10
1
curl --request POST \
2
     --url 'https://api.cloud.mbanq.com/v1/client/1234/notes?action=client' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --header 'tenantId: z01j3e71zd6zkq908vyf5861a8' \
6
     --data '
7
{
8
  "note": "Hello world note"
9
}
10
'

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

application/json

200The Note is created successfully.