Skip to main content

Internal Deposit

POST /transfers/deposit/internal

Description

It can be used to do deposit for internal account.

Path Parameters

NameTypeDescription
NoneNo parameters

Request Headers

NameTypeDescription
countryCodestringThe country code (header)
tenantIdstringThe tenant ID (header)
userIdstringThe user ID (header)

Request Body

  • Content Type: application/json
{
"recipientAccountId": "string",
"amount": 100,
"sendersName": "string",
"sendersBankCode": "string",
"sendersAccountNumber": "string",
"userId": "string",
"narration": "string",
"requestId": "string"
}

Response Code: 200 - OK

Description

Internal deposit successful.

Response Fields

FieldTypeDescription
statusbooleanIndicates if the operation was successful
statusCodeintegerStatus code
messagestringResponse message
dataobjectData related to the deposit
errorsarrayList of error messages, if any

Example

{
"status": true,
"statusCode": 0,
"message": "Internal deposit successful",
"data": {},
"errors": [
{
"message": "Some error occurred",
"descriptiveMessage": "Detailed error message"
}
]
}

Headers

Content-TypeValue
apiKey{{apiKey}}
countryCodestring
tenantIdstring
userIdstring

Body

{
"recipientAccountId": "rec123",
"amount": 100,
"sendersName": "John Doe",
"sendersBankCode": "XYZ123",
"sendersAccountNumber": "123456789",
"userId": "usr456",
"narration": "Deposit for savings",
"requestId": "req789"
}

🔑 Authentication bearer

|Param |Value |Type| |token |{{accessCode}} |string|

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request POST \ 
--url /transfers/deposit/internal \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!