Core Endpoints

core_endpoint_base_url: https://demo.etranzact.com/virtual-funding

Account

Generate Account

Description: Generate new virtual account

REQUEST PARAMETERS

Parameter	Type	Description	Required
productCode	String	Product making the request	Yes
accountType	Integer	Type of account where 0 = dynamic & 1 = reserved	Yes
accountName	Customer full name	Type of account where 0 = dynamic & 1 = reserved	Yes
customerID	String	Product customer ID. e.g PocketMoni customer ID	Yes
bvn	Integer	If accountType is 1, this field must be compulsory	No
bank	String	Partnering bank for virtual account creation. Default ‘Providus’	No
accountLimit	Integer	Account transaction limit	Yes
deviceID	String	FCM device ID for push notification	No

Sample Request

POST / account

curl `${core_endpoint_base_url}/account`
-H "Content-type: application/json"
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X POST
-d '{
   "productCode": "PKM",
   "accountType": 0,
   "accountName": "John Doe",
   "customerID": "080892364448",
   " bvn ": "",
   " bank": "Providus",
   " accountLimit": 20000,
   " deviceID": "c736-fnbyoo:APA91bH__uLN1okn3bmwrS7Hsy_ZA3LoDlqkZR0fhJbKBw_ic1UXsbR_SM2owlQJXU3ssNtILwQNXXBXczzZLdrrR4hJUr_MUfkyy-vELw83a1Q_mCZccw5V9rBKBhRpxpJtw1jjGRnI "
}'

Sample Response

POST / account

{
  "status": 201,
  "message": "Client Created",
  "execTime": 1.4888868,
  "error": "",
  "data": {
    "accountNo": " 9919286022",
    "accountName": " John Doe",
    "bank": "Providus",
    "customerID ": "080892364448",
    " accountLimit": 20000,
    " createdAt": " 2020-05-01 01:08:53",
    "expiringAt": " 2020-05-01 01:18:53 "
  }
}

Sample Failure Response

{
  "status": 503,
  "message": "",
  "error": "Service unavailable",
  "execTime": 1.4888868
}

UPDATE ACCOUNT

Description: Update user virtual account configuration

REQUEST PARAMETERS

Parameter	Type	Description	Required
productCode	String	Product making the request	Yes
customerID	String	Product customer ID. e.g PocketMoni customer ID	Yes
accountLimit	Integer	Account transaction limit	Yes
deviceID	String	FCM device ID for push notification	No

Sample Request

PUT / account/config

curl `${core_endpoint_base_url}/account/config`
-H "Content-type: application/json"
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X PUT
-d '{
  "productCode": "PKM",
  "customerID": "080892364448",
  "accountLimit": 25000,
  "deviceID": "c736-fnbyoo:APA91bH__uLN1okn3bmwrS7Hsy_ZA3LoDlqkZR0fhJbKBw_ic1UXsbR_SM2owlQJXU3ssNtILwQNXXBXczzZLdrrR4hJUr_MUfkyy-vELw83a1Q_mCZccw5V9rBKBhRpxpJtw1jjGRnI "
}'

Sample Response

PUT / account/config

{
  "status": 200,
  "message": "Account successful updated",
  "execTime": 1.4888868,
  "error": ""
}

QUERY ACCOUNT

Description: Retrieve a customer last active account

REQUEST PARAMETERS

Parameter	Type	Description	Required
productCode	String	Product making the request	Yes
customerID	String	Product customer ID. e.g PocketMoni customer ID	Yes

Sample Request

GET / account/getDetails?productCode=PKM& customerID=080833388383

curl https://{core_endpoint_base_url}/account/getDetails?productCode=PKM& customerID=080833388383
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X GET

Sample Response

GET / account/getDetails?productCode=PKM& customerID=080833388383

{
  "status": 200,
  "message": "successfully processed",
  "execTime": 0.02103607,
  "data": {
    "accountNo": " 9919286022",
    "accountName": " John Doe",
    " accountType": 0,
    "bank": "Providus",
    "customerID ": "080892364448",
    " accountLimit": 20000,
    " accountStatus": 0,
    " deviceID": "c736-   fnbyoo:APA91bH__uLN1okn3bmwrS7Hsy_ZA3LoDlqkZR0fhJbKBw_ic1UXsbR_SM2owlQJXU3ssNtILwQNXXBXczzZLdrrR4hJUr_MUfkyy-vELw83a1Q_mCZccw5V9rBKBhRpxpJtw1jjGRnI ",
    "createdAt": " 2020-05-01 01:08:53",
    "expiredAt": " 2020-05-01 01:18:53 ",
    "updatedAt": "",
    " updatedBy": " "
  }
}