Create Account

Call this end point to create an account on the platform by passing the wallet information.

Request

Security:

Bearer

path Parameters

version

required

string

Request Body schema: application/json

account_currencies	Array of strings or null List of currencies for the account creation. Valid only if account is being created. Data must be passed as ISO-3 string format.
wallet_guid	string <uuid> Unique Wallet GUID on the platform
wallet_id	string or null Platform generated id of the Wallet.
person_guid	string <uuid> Person unique identifer on the platform.
account_type	string (AccountType) Type of Account. Program level accounts: PROGFUND, REVENUE, COLLECTION, PROG_DISBURSE, EXCEPTION, WRITEOFF, SUSPENSE User accounts: GENERAL, PRINCIPAL, SECURE, CREDIT, ADVANCE, CHECK, USERDEFINED Enum: "GENERAL" "PROGFUND" "CHECK" "REVENUE" "COLLECTION" "PRINCIPAL" "SECURE" "CREDIT" "USERDEFINED" "ADVANCE" "PROG_DISBURSE" "EXCEPTION" "WRITEOFF" "SUSPENSE"
account_name	string or null A user defined name of the account.
account_limit	integer or null <int32> Account maximum limit; only applicable for ADVANCE type programs and corresponding accounts.

Responses

201

Returns the newly created Account

400

Bad request

401

Unauthorized

404

Wallet not found

500

Server Error

post/api/{version}/accounts

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"account_currencies": ["string"
],
"wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
"wallet_id": "string",
"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"account_type": "GENERAL",
"account_name": "string",
"account_limit": 0
}

Response samples

application/json

{"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
"account_currency": "string",
"account_name": "string",
"account_type": "GENERAL",
"available_balance": 0,
"ledger_balance": 0,
"suspense_balance": 0,
"advance_account_details": {"account": {"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
"start_date": "2019-08-24T14:15:22Z",
"limit": 0,
"outstanding_balance": 0,
"credit_product": "string",
"cycle": "string",
"status": "string",
"payment_summary": {"outstanding_principal": 0,
"disbursement_amount": 0,
"processing_fees": 0,
"carriedbalance_fees": 0,
"total_repayment": 0,
"number_of_payments": 0
},
"payment_schedule": [{"mob": 0,
"date": "2019-08-24T14:15:22Z",
"disbursement_principal": 0,
"disbursement_fee": 0,
"total": 0,
"fee": 0,
"principal": 0,
"balance": 0,
"paid_principal": 0,
"paid_interest": 0,
"available_balance": 0,
"cycle": "string",
"type": "string",
"status": "string"
}
],
"available_date_range": [{"name": "string",
"date": "2019-08-24T14:15:22Z"
}
]
}
},
"account_status": "SYSTEM",
"last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
"post_date": "2019-08-24T14:15:22Z",
"amount": 0,
"mask_account_number": "string",
"sys_utcinserted": "2019-08-24T14:15:22Z",
"status_change_nonmon_detail": {"nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
"txn_date": "2019-08-24T14:15:22Z",
"channel_name": "string",
"request_code": "string",
"reason_code": "string",
"response_code": "string",
"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"hash_account_number": "string",
"remarks": "string",
"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
"support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
"source_code": "string",
"source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
"reference_number": "string",
"outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
"order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
"processing_start_date": "2019-08-24T14:15:22Z",
"processing_end_date": "2019-08-24T14:15:22Z"
}
}