Process Flow
Create User (by Program)
Scenario:
- Program credential to create a User on the platform
Important Considerations:
- Users primary Emails must be unique as the system will not allow for the creation of a User if another verified email already exist.
- This scenario will not create Accounts (E-Wallet or Debit Card) for the User.
Step | Description | Grant Type | Notes | Sample |
1. | Action: Get program credential Token End Point: oauth/token |
program | View | |
2. | Action: Create User End Point: user |
program | View | |
3. | Action: Get User End Point: user/user_id |
program | Must pass the User ID to the End Point | View |
4. | Action: Update User End Point: user/user_id |
program | Must pass the User ID to the End Point | View |
Create and Activate Account for a User (in 2 Steps by Program)
Scenario:
- Program credential to create an Account (E-Wallet or Debit Card) linked to a User on the platform.
Important Considerations:
- A User must exist in the system and must be active.
- Account creation requirements must be met by the User in order for the system to create the Account, the requirements are:
- User country of residence: the country of the User primary address must be enabled (program configuration and can be modified).
- User verification status (Limited, Confirmed or Trusted) must be met (program configuration and can be modified).
- User age: The minimum age allowed to activate accounts (program configuration and can be modified).
- The Account creation and activation scenario for this flow is to create and activate a Virtual Debit Card to an existing User.
Step | Description | Grant Type | Notes | Sample |
1. | Action: Get program credential Token End Point: oauth/token |
program | View | |
2. | Action: Create User End Point: user |
program | View | |
3. | Action: Create Account End Point: account |
program | View | |
4. | Action: Get Account End Point: account/account_id |
program | Must pass the Account ID to the End Point | View |
Create User with Auto Create and Activate Account (in 1 Step by Program)
Scenario:
- Program credential to create a User and have the Account auto create for (E-Wallet or Debit Card) on the platform.
Important Considerations:
- This feature must be enabled on the Program to allow for auto Account creation.
- This may result in partial successful process, where the User gets created but the Account fails to create due to failing the account creation requirements; which means that the User information must be updated and a new Account creation request must be initiated.
- Account creation requirements must be meet by the User in order for the system to activate the account, the requirements are:
- User country of residence: the country of the User primary address must be enabled (program configuration and can be modified)
- User verification status of the user (Limited, Confirmed or Trusted) (program configuration and can be modified)
- User age: The minimum age allowed to activate accounts (program configuration and can be modified)
- The Account creating and activation scenario for this flow is to create and activate a Virtual Debit Card to a newly created User in a single request.
Step | Description | Grant Type | Notes | Sample |
1. | Action: Get program credential Token End Point: oauth/token |
program | View | |
2. | Action: Create User End Point: user |
program | View | |
3. | Action: Put Account End Point: account/account_id |
program | Must pass the Account ID to the End Point | View |
4. | Action: Get Account End Point: account/account_id |
program | Must pass the Account ID to the End Point | View |
Create User with Auto Create Account to be Activated by User after Receiving Physical Card by Mail, Step 1 by Program and Step 2 by User (2 Steps)
Scenario:
- Program credential to create a User and have the Account auto create for (Physical Debit Card) on the platform; when the user receives the card by mail; the user activates the card using User credential and activation code.
Important Considerations:
- This feature must be enabled on the Program to allow for auto Account creation.
- Account creation requirements must be meet by the User in order for the system to activate the account, the requirements are:
- User country of residence: the country of the User primary address must be enabled (program configuration and can be modified).
- User verification status of the user (Limited, Confirmed or Trusted) (program configuration and can be modified).
- User age: The minimum age allowed to activate accounts (program configuration and can be modified).
Get Account info, load funds into active Account and get Transaction history
Step | Description | Grant Type | Notes | Sample |
1. | Action: Get program credential Token End Point: oauth/token |
program | View | |
2. | Action: Create User End Point: user |
program | View | |
3. | Action: Create Currency End Point: user/currency/user_id |
program | Must pass the User ID to the End Point | View |
4. | Action: Create Account
End Point: account |
program | View | |
5. | Action: Get Account info
End Point: account/info/account_id |
program | Must pass the Account ID to the End Point | View |
6. | Action: Get Account Limits
End Point: account/limits/account_id |
program | Must pass the Account ID to the End Point | View |
7. | Action: Create Transaction
End Point: transaction |
program | View | |
8. | Action: Inquiry Transaction
End Point: transaction/inquiry? |
program | Must pass the Query parameters to the End Point | View |
Upload Document for identification Document for a User and Get Document Status (by Program)
Step | Description | Grant Type | Notes | Sample |
1. | Action: Get program credential Token End Point: oauth/token |
program | View | |
2. | Action: Create User End Point: user |
program | View | |
3. | Action: Create Document End Point: user/document/user_id |
program | Must pass the User ID to the End Point | View |
4. | Action: Get Document End Point: user/document/user_id |
program | Must pass the User ID to the End Point | View |
Replacement Process for Lost or Stolen Accounts (by Program)
Step | Description | Grant Type | Notes | Sample |
1. | Action: Create New Replacement Account for the User with Pending Activation Status or Active Status, Use Fulfilment Object to indicate that this is a Replacement Account. End Point: account |
program | View | |
2. | Action: Transfer Funds from Old Account to New Account using Generic Transfer Transaction Type End Point: transaction |
program | View | |
3. | Action: Change Account Status to Lost or Stolen End Point: account/account_id |
program | View |