To create an Account, you need to issue Account/Payment products to an Account Holder by using Bundles as per the value offering of the fintech.
Follow the below steps to issue an Account to an Account Holder:
These steps are briefly explained with corresponding API request and response samples in the following sections:
Call /bundles
endpoint to retrieve all the existing Accounts available for the IFI.
/api/v1/ifi/{ifiID}/bundles |
ifiID
: Required. Unique identifier of the IFI.id
: ID of the Bundle retrieved.ifiID
: Unique identifier of the IFI.vboID
: Unique identifier of the fintech.name
: Name of the retrieved Bundle.status
: Status of the retrieved Bundle.createdAt
: Timestamp of the Bundle creation.updatedAt
: Timestamp of the last Bundle update.
|
Use the /issueBundle
endpoint to issue an Account to Account Holder. Pass the value of ID parameter from the previous step for bundleID
as shown in the following cURL sample:
/api/v1/ifi/{ifiID}/bundles/{bundleID}/issueBundle |
ifiID
: Required. Unique identifier of the IFI.bundleID
: Required. ID of the Bundle being issued.accountHolderID
: Required. ID of the Account Holder to whom the Account is being issued.name
: Required. Name of the issued Bundle.phoneNumber
: Required. Phone number associated with the Account Holder.bundleID
: ID of the issued Bundle.accountHolderID
: ID of the Account Holder.accountID
: ID of the Account Product.resourceID
: ID of the Resource associated with the Payment Instrument.status
: Status of the issued Bundle.targetAccount
: If the Bundle does not have any Account Products, the targetAccountID
shall be used in the payment instrument field.
|
You can also create an Account with a single Account Product as per the Account Holder’s requirement. Use the /issueAccount
endpoint to issue a specific Account Product to an Account Holder, identified by accountHolderID
. Pass the accountProductID
and ID of the Bundle that the Account Product belongs to. ID of the Bundle is retrieved from the response of the /bundles
endpoint.
/api/v1/ifi/{ifiID}/bundles/{bundleID}/issueAccount |
ifiID
: Required. Unique identifier of the IFI.bundleID
: Required. ID of the Bundle whose Account Product is being issued.accountHolderID
: Required. ID of the Account Holder to whom the Account Product is being issued.accountProductID
: Required. ID of the Account Product being issued.name
: Required. Preferred name in the Account.
|
An array of Account Products are taken as request by providing accountProductID
. The response returns the type and status of the Account Product. The status depends on the issuance state of the Account Product.
/api/v1/ifi/{ifiID}/bundles/{bundleID}/issueAccountProducts |
ifiID
: Required. Unique identifier of the IFI.bundleID
: Required. ID of the Bundle whose Account Product is being issued.requestID
: Required. This is the idempotency field. ID used by fintech to identify a unique request.accountHolderID
: Required. ID of the Account Holder to whom the Account Product is being issued.accountProductID
: Required. ID of the Account Product being issued.name
: Required. Preferred name in the Account.accountHolderID
: ID of the Account Holder to whom the Account Product is issued.accountID
: ID of the issued Account Product.bundleID
: ID of the Bundle whose Account Product is issued.name
: Preferred name in the Account.status
: Status of the issued Account Products.type
: Type of Account.
|
An array of Payment Products are taken as request by providing paymentProductID
. The response returns the type and status of the Account Product. The status depends on the issuance state of the Account Product.
/api/v1/ifi/{ifiID}/bundles/{bundleID}/issuePaymentProducts |
ifiID
: Required. Unique identifier of the IFI.bundleID
: Required. ID of the Bundle whose Payment Product is being issued.requestID
: Required. This is the idempotency field. ID used by fintech to identify a unique request.targetAccountID
: Optional. If the Bundle does not have any Account Products, the targetAccountID
shall be used in the payment instrument field.paymentProductID
: Required. ID of the Payment Product being issued.phonenumber
: Required. Phone number being associated with the Account.accountHolderID
: ID of the Account Holder to whom the Account Product is issued.accountID
: ID of the issued Account Product.bundleID
: ID of the Bundle whose Account Product is issued.name
: Preferred name in the Account.status
: Status of the issued Account Products.type
: Type of Account.
|
|