Initiate a closed loop debit transaction for a particular users wallet in the system.
Header Parameters
Authorizationstring
Body Parameters
ruleobject
If allow_split_category_transaction is defined as true, rule based priority is considered.
Show child attributes
emailstring
Receiver email address
mobile_country_codestring
Receiver mobile country code
mobilestring
Receiver mobile number
amountstring
Amount to be added to the recipient, only present if allow_dynamic_category_allocation is false
hash_idstring
The hash_id of the user's wallet for which the fund transaction is being initiated
user_idstring
The user_id of the user for which the fund transaction is being initiated
detailsstring
JSON encoded text string containing the details of the deduction
fund_category_namestring
Fund category name
allow_split_category_transactionboolean
If defined as true system priority is overridden by rule based priority.
Response
200
Object
OK
Response Attributes
idstring
Transaction reference identifier
ref_idstring
Transaction reference identifier
user_idstring
User id of the user for whcih the transaction was performed
wallet_idstring
Wallet identifier
card_idstring
Card identifier
confirmstring
Indicator if the transaction needs to be confirmed or not. Values can be [require or skip]
category_detailsarray
Show child attributes
400
Object
Bad Request
| Code | Description |
| :--- | :---------- |
| resource_user_wallet_fund_receiver_no_match | Receiver cannot be found or does not exist |
| resource_user_wallet_card_hash_id_pan_invalid | Either `hash_id` or `pan` must not be empty |
| resource_user_wallet_fund_amount_format_invalid | Invalid `amount` format |
| resource_user_wallet_fund_amount_max_length | `amount` must not exceed 9 digits long |
| resource_user_wallet_fund_amount_min_value | `amount` must be greater than 0 |
| resource_user_wallet_fund_require_receiver_criteria | Provide a parameter to identify receiver |
| resource_user_wallet_fund_mobile_insufficient_dependency | Both `mobile_country_code` and `mobile` must be specified |
| resource_user_wallet_fund_insufficient_debit_prefund | Program account fund is insufficient |
| user_not_found | User not found or does not exist |
| user_parameter_validation_failed_1 | Field required not met; Invalid `amount` format |
| user_parameter_validation_failed_2 | Field required not met; `amount` must not be empty or zero |
| user_parameter_validation_failed_3 | Field required not met; Invalid dialing country code format |
| user_parameter_validation_failed_4 | Field required not met; Payment details is too long. It should be less than 512 characters |
| user_parameter_validation_failed_5 | Field required not met; Invalid `allow_split_category_transaction` or `amount` |
| user_parameter_validation_failed_6 | Field required not met; Invalid `allow_split_category_transaction` or `rule` |
| user_parameter_validation_failed_7 | Field required not met; Invalid `fund_category_name` or `allow_split_category_transaction` |
| resource_card_fund_transfer_purse_daily_limit_reached | Daily purse limit reached |
| resource_card_fund_transfer_purse_daily_count_limit_reached | Daily count limit reached |
| resource_card_fund_transfer_purse_weekly_limit_reached | Weekly purse limit reached |
| resource_card_fund_transfer_purse_weekly_count_limit_reached | Weekly count limit reached |
| resource_card_fund_transfer_purse_monthly_limit_reached | Monthly purse limit reached |
| resource_card_fund_transfer_purse_monthly_count_limit_reached| Monthly count limit reached |
| resource_card_fund_transfer_purse_annual_count_limit_reached | Annual count limit reached |
| resource_card_fund_transfer_purse_lifetime_count_limit_reached | Lifetime count limit reached |
| resource_card_fund_transfer_purse_unit_transactional_limit_reached | Unit transactional limit reached |
| resource_user_wallet_fund_details_format_invalid | Payment details is too long. It should be less than 512 characters
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
401
Object
Unauthorized request
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
403
Object
Forbidden
| Code | Description |
| :--- | :---------- |
| restricted_resource | Access with method `POST` denied |
|risk_management_engine_error | An exception occurred during the processing of the risk and compliance of the user. |
| user_blocked_risk_threshold_exceeded | User have exceeded the risk and compliance threshold and was automatically blocked. |
Response Attributes
codeinteger Required
descriptionstring Required
linkstring Required
404
Object
Resource not found
| Code | Description |
| :--- | :---------- |
| resource_not_found | The requested URL was not found |