List of DCB APIs

List of DCB APIs

Customers

 

POST - Individual Customer - Base Data

Base data fields related to the type of customer entity, such as individuals, companies or other types configured in the platform. Fields like: name , last name, address, document ID, phone number and others.

 

POST - Company Customer - Base Data

Base data fields related to the type of customer entity, such as individuals, companies or other types configured in the platform. Fields like: name , last name, address, document ID, phone number and others.

 

POST - Individual Customer ID

Customer ID check, this data set is related to the validation of Individual customer ID, additional fields are related to the date when the check was done and organization that provided the check.

 

POST - Company Customer ID

Customer ID check, this data set is related to the validation of Company  customer ID, additional fields are related to the date when the check was done and organization that provided the check.

 

POST - Individual Customer Economical Data

Customer Economical data set, such as monthly salary, company or employment data, family members, renting or own the house and alike data.
The same data set managed with PUT and GET APIs.

 

POST - Company Customer Economical Data

Customer Economical data set, such as monthly company revenue, merchant sector, number of employee, renting or own facilities and alike data.
The same data set managed with PUT and GET APIs.

 

POST - Individual Customer

Individual Customer AML (anti money laundering) check, this data set is related to the validation of customer AML, additional fields are related to the date when the check was done and organization that provided the check. The organization providing the AML check uses the international black list, PEPs and local country specific list.

 

AML Check

 

POST - Company Customer

Company Customer AML (anti money laundering) check, this data set is related to the validation of customer AML, additional fields are related to the date when the check was done and organization that provided the check. The organization providing the AML check uses the international black list, PEPs and local country specific list.

 

AML Check

 

POST - Individual Customer

Individual Customer Score from Mobile telco Operator, this data set is related to the scoring that the MNO assigns to the customer as per CRM related information, This is an optional data set, used when MNO data is available, additional fields are related to the date when the score was done and MNO organization that provided the score.

 

Mobile Operator Score

 

POST - Credit Scoring

Customer Credit  Score (individual or company)  from either third party or a custom scoring model based on VBN platform, this data set is related to the scoring that assigns to the customer a periodically computed score to qualify for the loan products provided by the financial organization.

 

POST - Customer Document

Customer (individual or company) related document/s, these files that may be scans, photo, contracts in PDF formal or any other file format, are added to the platform tables and related to the selected customer ID.

 

PUT - Individual Customer data sets

The PUT (Update) web services APIs are available for all of the above POST data sets.

 

PUT - Company Customer data sets

The PUT (Update) web services APIs are available for all of the above POST data sets.

 

GET - Individual  Customer data sets

The GET (Read) web services APIs are available for all of the above POST data sets.

 

GET - Company  Customer data sets

The GET (Read) web services APIs are available for all of the above POST data sets.

 

GET  -  Customer Accounts List

The GET (Read) web service that retrieves all the accounts that a customer (individual or company) has. These include any type of Wallet/s, Saving/s with real-time updated balance and account details (number, type, codes) and Loans of any type with updated residual capital to pay and additional details.

 

GET - Documents List

The GET (Read) web service that retrieves all the documents related to the specific customer (individual or company) and details about the document ID and file type.

 

GET - Document

The GET (Read) web service that retrieves the documents (for individual or company) specific document number and details about it and file.


Wallets

 

POST - Wallet for Individual Customer

Inserts into the platform data base  Wallet records based on the parameters passed (Customer ID, Wallet Product code and other fields)

 

POST - Wallet for  Company Customer

Inserts into the platform data base  Wallet records based on the parameters passed (Customer ID, Wallet Product code and other fields)

 

POST - DEBIT Wallet Transaction

Performs a Debit transaction to the target Wallet and updates the platform tables related to the transaction, in addition generates a unique transaction number.

 

POST - CREDIT Wallet Transaction

Performs a Credit transaction to the target Wallet and updates the platform tables related to the transaction, in addition generates a unique transaction number.

 

POST -

Account Transfer Transaction among  Wallets

Performs a Debit from the source Wallet and a Credit to the target Wallet updates the platform tables related to the transactions, in addition generates a unique transaction number.

 

POST -

Account Transfer Transaction among  Wallet and Savings

Performs a Debit from the source Wallet and a Credit to the target Savings updates the platform tables related to the transactions, in addition generates a unique transaction number.

 

POST - Account Transfer Cross Banks among  Wallets

Performs a Debit from the source Wallet (from the source bank tenancy) and a Credit to the target Wallet (to the target bank tenancy), updates the platform tables related to the transactions for both banks tenancies involved, in addition generates a unique transaction numbers for the tenancies.

 

GET - Wallet Balance and Movements

Performs a retrieval of the Wallet base details (Wallet Product code and others) and list of latest movements with amount, debit/credit sign, time stamps, in addition a parameter can be passed for the movements to be retrieved.


Savings

 

POST - Savings

 for Individual Customer

Inserts into the platform data base  Savings records based on the parameters passed (Customer ID, Savings Product code and other fields)

 

POST - Savings

 for  Company Customer

Inserts into the platform data base  Savings records based on the parameters passed (Customer ID, Savings Product code and other fields)

 

POST - DEBIT

Savings Transaction

Performs a Debit transaction to the target savings and updates the platform tables related to the transaction, in addition generates a unique transaction number.

 

POST - CREDIT Savings Transaction

Performs a Credit transaction to the target Wallet and updates the platform tables related to the transaction, in addition generates a unique transaction number.

 

POST -

Account Transfer Transaction among  Savings and Wallets

Performs a Debit from the source Savings and a Credit to the target Wallet updates the platform tables related to the transactions, in addition generates a unique transaction number.

 

GET - Savings Balance and Movements

Performs a retrieval of the Savings base details (Savings Product code and others) and list of latest movements with amount, debit/credit sign, time stamps, in addition a parameter can be passed for the movements to be retrieved.


 

POST - Loan

Single Payment Type for Individual  Customer

Inserts into the platform data base  a Loan heading with status Open, with the parameters related to the specific Loan product for Individual customer  selected, such as Customer ID, Amount requested, Due Date, upon processing the platform return a Loan number assigned to be used for following transactions.

 

POST - Loan

Single Payment Type for Company  Customer

Inserts into the platform data base  a Loan heading with the parameters related to the specific Loan product for Company customer selected, such as Customer ID, Amount requested, Due Date, upon processing the platform return a Loan number assigned to be used for following transactions.

 

POST - Disbursement for Loan Single Payment Type

Perform the Disbursement for the Single Payment Loan type, either for Individual or Company customers, in addition generates the single installment  payment plan with the computation of related capital (principal) and interest amount based on the loan's conditions settings.

 

POST - Loan

Revolving Type

for Individual  Customer

Inserts into the platform data base  a Loan heading with status Open, with the parameters related to the specific Loan product for Individual customer  selected, such as Customer ID, Amount requested, Installment Amount selected, upon processing the platform return a Loan number assigned to be used for following transactions.

 

POST - Loan

Revolving Type

for Company  Customer

Inserts into the platform data base  a Loan heading with status Open, with the parameters related to the specific Loan product for Company customer  selected, such as Customer ID, Amount requested, Installment Amount selected, upon processing the platform return a Loan number assigned to be used for following transactions.

 

POST - Disbursement for Loan Revolving Type

Perform the Disbursement for the Loan Revolving type, either for Individual or Company customers, in addition generates the payment plan with the computation of related capital (principal) and interest amount based on the loan's conditions settings and derived number of installments.

 

POST -

Re-Disbursement

for Loan Revolving Type

Perform the Re-Disbursement (new disbursement) for the Loan Revolving type, either for Individual or Company customers, in addition generates an updated  payment plan with the computation of related capital (principal) and interest amount based on the loan's conditions settings and derived number of installments.

 

POST - Loan

Standard Amortization Type

for Individual  Customer

Inserts into the platform data base  a Loan heading with status Open, with the parameters related to the specific Loan product for Individual customer  selected, such as Customer ID, Amount requested, Number of Installments selected, upon processing the platform return a Loan number assigned to be used for following transactions.

 

POST - Loan

Standard Amortization Type

for Company  Customer

Inserts into the platform data base  a Loan heading with status Open, with the parameters related to the specific Loan product for Company customer  selected, such as Customer ID, Amount requested, Number of Installments selected, upon processing the platform return a Loan number assigned to be used for following transactions.

 

POST - Disbursement for Loan Revolving Type

Perform the Disbursement for the Loan Standard Amortization type, either for Individual or Company customers, in addition generates the payment plan with the computation of related capital (principal) and interest amount based on the loan's conditions settings and derived number of installments.

 

GET - Loan Details

Performs a retrieval of the Loan main details (Customer number, Loan number, capital requested, number of installments, next due installment and payment play with current status with paid or unpaid installments. This retrieval is applicable for any type of loan product.

 

POST -

Anticipated Payment

Performs an Anticipated Payment of Capital, applicable to any loan product type, the parameters are loan number and amount of payment. Upon this anticipated payment an updated payment plan is generated as per amount paid and date of payment.