bcs-products-management-api-service

API INFORMATION

Title: products-management-api-service

Version: 1.0.66

Protocols: HTTPS

URI Sandbox: https://products-management-api-services-dev.us-e1.cloudhub.io/productsManagement/v1

URI QA: https://products-management-api-services-qa.us-e1.cloudhub.io/productsManagement/v1

URILive: https://products-management-api-service-prod.us-e1.cloudhub.io/productsManagement/v1

DOWLOAD RAML

DESCRIPTION

The api will offer the consumers to query information on Consolidated profile information , product details operation,using criteria related to product number,allowing the following operations:

Summary

-Consolidated Profile

Path:

/productsManagement/v1/{identSerialNum}:

URI parameters

identSerialNum: Identification number

Query parameters

govIssueIdentType: Type of identification issued by the government of the country

flagStateProduct: Flag that indicates if all the products are consulted, or only the active ones.

Response information:

responseType: Used to return the response.

govIssueIdent: Identification given by the local government.

personName: Customer information.

listProducts: List with all the products associated with the client.

It can contains the following types of objects depending on the product, the following table show how the relationship.

> DepAcctId

Object can have information of products of Savings account, Current accounts, AFC account, Count my piggy bank and Correspondent bank account.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product.

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{

 .

  .

   "acctId": "24026078999",

   "acctType": "SDA",

   "externalId": "24026078999-SDA-AHO",

   .

  .

 }

{

 .

  .

   "acctId": "21002787999",

   "acctType": "DDA",

   "externalID": "21002787999-DDA-CTA",

  .

 .

}

\`\`\`

**depAcctProdTypeBM:** Account type code in Bank Master for following products (Savings account, Current accounts, AFC account, Count my piggy bank, Correspondent bank account)

**bankAcctStatus:** Contains the description and states of People in Core OpenCard.

bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).

statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

```

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

term: Details about an account or credit

 flagSavingsPlan: It has a savings plan.
 flagNewSavingsPlan: New Savings plan type indicator.
 flagAutomDebit: If you have automatic debit enabled.

additionalAcctId: List with Number of Associated Accounts

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> CDAAcctId

Object can have information of products of CDTs._

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "25900000999",
   "acctType": "CDA",
   "externalId": "25900000999-CDA-CDT",
   .
  .
 }

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

additionalAcctId: List with Number of Associated Accounts

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> CardAcctId

Object can have information of products of Credit cards and Debit cards.

acctId: Identifier of an account.

(For credit cards,The value has been masked, only the first 6 digits and the last 4 are visible.)

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

secObjValue: Credit card with encrypted value.

Examples (externalID/secObjValue):

{
 .
  .
   "acctId": "457022******4836",
   "acctType": "CCA",
   "secObjValue": "c8cced9ca11df3968a568ec8e1eae110",
   "externalID": "c8cced9ca11df3968a568ec8e1eae110-CCA-TCR",
  .
 .
}

{
 .
  .
   "acctId": "24519837999",
   "acctType": "DBC",
   "externalId": "24519837999-DBC-",
   .
  .
 }

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Additional response information, can be considered backend response (Credit card)

statusCode: Status account
statusDesc: Explanation associated with the statusCode
personOCStatusCode: People Status Code in Core OpenCard
personOCStatusDesc: Description of People Status Code in Core OpenCard
restructurationOCStatusCode: Restructuring Status Code in Core OpenCard
restructurationOCStatusDesc: Description of Restructuring Status Code in Core OpenCard
overdraftOCStatusCode: Status Code Overcrowding in Core OpenCard
overdraftOCStatusDesc: Description of Status Code Overcrowding in Core OpenCard
unpaidDebtOCStatusCode: Code State Wallet in Core OpenCard
unpaidDebtOCStatusDesc: Description of Code State Wallet in Core OpenCard

term: Details about an account or credit (Credit Card)

cardTypeCode: Type of credit card assignment given to the customer
renewalApproval: When the card is about to expire, it defines if the renewal approval was made
flagCCFixedTerm: Flag for activation of the fixed term for purchases exclusively for credit card
flagAutomDebit: If you have automatic debit enabled.

additionalAcctId: List with Number of Associated Accounts (Debit Card)

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> LoandInfoCommon

Object can have information of products of Credits and Rotating credits.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "24519837999",
   "acctType": "ILA",
   "externalID": "24519837999-ILA-",
  .
 .
}

{
 .
  .
   "acctId": "24519837999",
   "acctType": "RLA",
   "externalId": "24519837999-RLA-CRT",
   .
  .
 }

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Additional response information, can be considered backend response

statusCode: Contains status Core bank master (BM)  statusDesc: Contains description Core bank master (BM).
personOCStatusCode: People Status Code in Core OpenCard (Rotating Credits).
personOCStatusDesc: Description of People Status Code in Core OpenCard (Rotating Credits).
restructurationOCStatusCode: Restructuring Status Code in Core OpenCard (Rotating Credits).
restructurationOCStatusDesc: Description of Restructuring Status Code in Core OpenCard (Rotating Credits).
overdraftOCStatusCode: Status Code Overcrowding in Core OpenCard (Rotating Credits).
overdraftOCStatusDesc: Description of Status Code Overcrowding in Core OpenCard (Rotating Credits).
unpaidDebtOCStatusCode: Code State Wallet in Core OpenCard (Rotating Credits).
unpaidDebtOCStatusDesc: Description of Code State Wallet in Core OpenCard (Rotating Credits).

term: Details about an account or credit

 flagAutomDebit: If you have automatic debit enabled.

dueDt: Payday limit

externalDueDt: External Payday limit

authSystem: Bank Authorizing System (Credit)

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> CapitalizationAcctId

Object can have information of products of Cross product.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "24519837999",
   "acctType": "CPA",
   "externalID": "24519837999-CPA-",
  .
 .
}

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: State Account
 statusDesc: Explanation associated with the statusCode

capitalizationAcctAm: Applies to capitalization titles and corresponds to the value for which the title was opened

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> InsuranceInfo

Object can have information of products of SLiberty insurance and Colmena insurance.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "24519837999",
   "acctType": "LIA",
   "externalID": "24519837999-LIA-",
  .
 .
}

{
 .
  .
   "acctId": "24519837999",
   "acctType": "CIA",
   "externalID": "24519837999-CIA-",
  .
 .
}

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: State Account
 statusDesc: Explanation associated with the bankAcctStatusCode

insuranPremiumValue: For policies, it is the value that must be paid periodically to have that insurance

totalInsurableValue: For periodic loan, it is the value that the insurer will cover in case of an accident, depending on the conditions in which the insurance was taken.

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> FiduciaryAcctId

Object can have information of products of Fiduciary Assignments.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "24519837999",
   "acctType": "OFA",
   "externalID": "24519837999-OFA-CRZ",
  .
 .
}

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

additionalAcctId: List with Number of Associated Accounts

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "2",
        "errorDesc": "Error description.",
        "errorType": "CLI"
    }
}

> Diagram of sequence.

####

##

-ProductList

-Product Detail Operations

/productsManagement/v1/productDetail/{acctId}:

Resource that obtains product detail operations, query parameters for each product :

 - SDA

 - DDA

 - CDA

 - OFA

 - ILA

 - CCA

 - RLA

 - DBC

Enviroments [DEV,QA]

*Savings account reponse:*

Request example:

Path:

/productsManagement/v1/productDetail/{acctId}?acctType=SDA

/productsManagement/v1/productDetail/{acctId}?acctType=DDA

URI parameters

acctId

Query parameters

acctType: SDA or DDA

This acctType is used to query information related to savings account product. The objects of the operation are described below:

Response information:

responseType: Used to return the response type.

depAcctId: Contains information related to savings account product.

acctId:  Contains information related to product number.
listCardsNum:  Contains information of associated debid card.
fee:  Contains information about Amount of programmed savings pocket, Extraordinary Fee.
dayOneDebitToPocket:  Contains information about day to debit one.
dayTwoDebitToPocket:  Contains information about day to debit two.
extAcctBal:  Contains (Overdraft days / days of use) and overdraft used.
curAmt:  Contains a list all the data of the different balance e.g. Total balance , Available Balance , Exchange Balance , Pocket Balance,Total contingent withholding, Credit saving guarantee.
loanInfoCommon:  Contains information of maximum Payment Date.
acctBal:  List all the data of the different balances, debts or amounts to pay, e.g., Space available , Quota used , Assigned Quota .
conditionInfo:  Contains  information of handling conditions.
bankInfo:  Contains  information of  office  code.
term: Details about an account  flag savings plan , flag new savings plan , flag autom debit.

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

responseDetail: Contains the description only for error cases.

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "20003",
        "errorDesc": "There is no record for the account 24024922817",
        "errorType": "LGN"
    }
}

> Diagram of sequence.

*Certificate Of Deposit Operation Reponse:*

Request example:

Path:

/productsManagement/v1/productDetail/{acctId}?operation=CDA

URI parameters

acctId

Query parameters

acctType: CDA

This acctTypeis used to query information related to certificate of deposit product. The objects of the operation are described below:

Response information:

responseType: Used to return the response type.

CDAAcctId: Contains all the information related to this specific product such as:

  acctId: Contains  information of product number.
  nextPmtDt: Contains  information of next expiration date.
  lastPmtDt: Contains  information of last expiration date.
  curAmt: Contains  information of  total balance.
  term: Contains  information of opening value.
  intRateInfo: Contains  information of outstanding interest receivable / Annual effective rate.
  additionalAcctId: Contains  information of number of Associated Accounts.

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

responseDetail: Used in error cases.

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "20003",
        "errorDesc": "There is no record for the account 24024922817",
        "errorType": "LGN"
    }
}

> Diagram of sequence.

####

*Fiduciary Operation Reponse:*

Request example:

Path:

-/productsManagement/v1/productDetail/{acctId}?acctType=OFA

• /productsManagement/v1/productDetail/{acctId}?acctType=OFA&daysJourney=Normal&operationMode=Online

URI parameters

acctId

Query parameters

acctType: OFA

daysJourney (Optional default value: Normal)

-Normal

-Additional

operationMode (Optional default value: Online)

-Online

-Out

This operation is used to query information related to fiduciary products. The objects of the operation are described below:

Response information:

responseType: Used to return the response type.

fiduciaryAcctId: Contains all the information related to this specific product such as:

  partyAcctRelRec: Contains  information of opening date
  bankInfo:  Contains  information of  office  code.
  additionalAcctId: Contains  information of number of Associated Accounts.
  endDt:Contains information of  closing date.
  cityId: Contains  information of city ID associated with the client.
  acctId: Contains information of product number.
  curAmt: Contains all the amounts for  fiducia,eg: Available Balance ,Exchange Balance ,Total balance,Available balance in units ,Exchange balance in units ,Total balance in units.
  fee: Contains  information of Unit value to perform conversion for balances.
  conditionInfo:Contains  information of handling conditions.

contactInfo: Contains information related to customer data such as:

  postAddr: Contains  information of  address.
  phoneNum:  Contains  information of phone number.
  emailAddr: Contains  information of email.

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

responseDetail: Used for error cases.

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
 {
  "cabeceraSalida": {
    "tipoRespuesta": "ER",
    "respuestaError": {
      "codigoError": "1002",
      "descripcionError": "DATABASE ERROR PLEASE WAIT",
      "tipoError": "DBA"
    }
  }
}

> Diagram of sequence.

####

*Loan Operation Reponse:*

Request example:

Path:

/productsManagement/v1/productDetail/{acctId}?acctType=ILA

URI parameters

acctId

Query parameters

acctType: ILA

This acctTypeis used to query information related to loan . The objects of the operation are described below:

Response information:

loanInfoCommon: Object that contains all the elements related to loans.

responseType: Used to return the response type.

acctId: Identifier of an account

lastPmtDt:: Final due date.

collateralDesc: Amortization system

completedPmtCount: Fees paid

freq: Periodicity

authSystem: Authorizing system

totalPmtCount: Total loan installments

dueDt: Payday limit

externalDueDt: External Payday limit

term: Details about an account or credit

 flagAutomDebit: If you have automatic debit enabled.

intRateInfo: List with rate information e.g.

• Agreed rate (E.A.)
• Rate charged (E.A.)
• Rate with benefit (E.A.)
• EA Interest Rate
• Discounted Rate

curAmt: List with contains all balances, total debt, total payment value.

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "2",
        "errorDesc": "Error description.",
        "errorType": "CLI"
    }
}

> Diagram of sequence.

####

##

*Credit Card Operation Reponse:*

Request example:

/productsManagement/v1/productDetail/{acctId}?acctType=CCA

URI parameters

acctId: Number of product (If the channel know what is the number of card can send acctID on clear, and if the channel not know your need send encrypted value).

Query parameters

acctType: CCA

This acctType is used to query information related to credit card operations. The objects of the operation are described below:

cardAcctId: Object that contains all the elements related to loans.

responseType: Used to return the response type.

acctId: Identifier of an account. (For credit cards,The value has been masked, only the first 6 digits and the last 4 are visible.)

loyaltyPgmInfo: Contains information about points related to the card

matDt: Next court date

nextPmtDt: Next payment deadline

dueDt: Payday limit

minPmtCurAmt: Minimum Payment

curAmt: List containing information on Assigned quota, Available quota Purchases, Available quota Advances

CCAcctRec: Expiration date

partyAcctRelRec: Information about a product

acctBal: Account balances

depAcctIdFrom: Automatic debit account number

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Additional response information, can be considered backend response (Credit card)

statusCode: Contains status Core bank master (BM)
statusDesc: Contains description Core bank master (BM).
personOCStatusCode: People Status Code in Core OpenCard
personOCStatusDesc: Description of People Status Code in Core OpenCard
restructurationOCStatusCode: Restructuring Status Code in Core OpenCard
restructurationOCStatusDesc: Description of Restructuring Status Code in Core OpenCard
overdraftOCStatusCode: Status Code Overcrowding in Core OpenCard
overdraftOCStatusDesc: Description of Status Code Overcrowding in Core OpenCard
unpaidDebtOCStatusCode: Code State Wallet in Core OpenCard
unpaidDebtOCStatusDesc: Description of Code State Wallet in Core OpenCard

term: Details about an account or credit (Credit Card)

cardTypeCode: Type of credit card assignment given to the customer
renewalApproval: When the card is about to expire, it defines if the renewal approval was made
flagCCFixedTerm: Flag for activation of the fixed term for purchases exclusively for credit card
flagAutomDebit: If you have automatic debit enabled.

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "2",
        "errorDesc": "Error description.",
        "errorType": "CLI"
    }
}

> Diagram of sequence.

####

##

*Revolving Credit Operation Reponse:*

Request example:

/productsManagement/v1/productDetail/{acctId}?acctType=RLA

URI parameters

acctId

Query parameters

acctType: RLA

This acctType is used to query information related to revolving credit card operations. The objects of the operation are described below:

cardAcctId: Object that contains all the elements related to rotating credits..

responseType: Used to return the response type.

acctId: Identifier of an account

matDt: Next court date

nextPmtDt: Next payment deadline

dueDt: Payday limit

acctBal: Account balances

curAmt: List containing information on Assigned quota, Available quota Purchases

minPmtCurAmt: Minimum Payment

CCAcctRec: Expiration date

depAcctIdFrom: Automatic debit account number

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Additional response information, can be considered backend response (Credit card)

statusCode: Contains status Core bank master (BM)
statusDesc: Contains description Core bank master (BM).
personOCStatusCode: People Status Code in Core OpenCard
personOCStatusDesc: Description of People Status Code in Core OpenCard
restructurationOCStatusCode: Restructuring Status Code in Core OpenCard
restructurationOCStatusDesc: Description of Restructuring Status Code in Core OpenCard
overdraftOCStatusCode: Status Code Overcrowding in Core OpenCard
overdraftOCStatusDesc: Description of Status Code Overcrowding in Core OpenCard
unpaidDebtOCStatusCode: Code State Wallet in Core OpenCard
unpaidDebtOCStatusDesc: Description of Code State Wallet in Core OpenCard

term: Details about an account or credit (Credit Card)

renewalApproval: When the card is about to expire, it defines if the renewal approval was made
flagAutomDebit: If you have automatic debit enabled.

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "2",
        "errorDesc": "Error description.",
        "errorType": "CLI"
    }
}

> Diagram of sequence.

####

*Debit card operation response:*

Request example:

/productsManagement/v1/productDetail/{acctId}?acctType=DBC

URI parameters

acctId

Query parameters

acctType: DBC

This acctType is used to query information related to revolving credit card operations. The objects of the operation are described below:

Response:

responseType: Used to return the response type.

> CardAcctId

Object can have information of products of Debit cards.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID/secObjValue):

{
 .
  .
   "acctId": "5895180000010171999",
   "acctType": "DBC",
   "externalId": "5895180000010171098-DBC-"
  .
 .
}

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of acount.
 statusDesc: Contains description of acount.

additionalAcctId: List with Number of Associated Accounts (Debit Card)

CCMotoAcct: CCMotoAcct: Card franchise name and description

Examples:

{
 .
  .
   "CCMotoAcct": {
      "brand": "V",
      "desc": "VISA"
   }
  .
 .
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "2",
        "errorDesc": "Error description.",
        "errorType": "CLI"
    }
}

##

* Consult Payment Agreement:*

This operation is used to consult the payment agreement:

Request example:

/products-management/v1/PaymentAgreement

Query parameters

govIssueIdentType: User Identification Type
identSerialNum: User Identification Number
emailAddr: Contact Email
numProduct: Product Identification Number
expDays: expiration day of product

responseType:

govIssueIdent: Contains user information.

govIssueIdentType: User Identification Type
identSerialNum: User Identification Number

contactInfo: Contains contact information

emailAddr: Contact email

productId: Contains product information

numProduct: Product identification number

loanInfoCommon: Contains expiration information

expDays: Expiration day

paymentAgreement: Contains payment information

idAgreement: Deal identifier
payDayNumber: Payday

notification: Contains the message

message: Mail message

Example

{
    "govIssueIdent": {
        "govIssueIdentType": "CC",
        "identSerialNum": "123456789"
    },
    "contactInfo": {
        "emailAddr": "prueba@gmail.com"
    },
    "productId": {
        "numProduct": "123987654"
    },
    "loanInfoCommon": {
        "expDays": "5"
    },
    "paymentAgreement": {
        "idAgreement": "1",
        "payDayNumber": "10"
    },
    "notification": {
        "message": "envio de respuesta"
    }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
      "value": "ER"
   },
  "responseDetail": {
      "errorCode": "00001",
      "errorDesc": "Error acuerdo de pago.",
      "errorType": "BDA"
   }
}

> Diagram of sequence.

####

##

* Consult Payment Agreement (Version 2):*

This operation is used to consult the payment agreement version 2:

Request example:

/products-management/v2/PaymentAgreement

Query parameters

govIssueIdentType: User Identification Type
identSerialNum: User Identification Number
emailAddr: Contact Email
numProduct: Product Identification Number
expDays: Expiration day of product
idAgreement: Identification Agreement
payDayNumber: Pay Day Number
amt: Balance in arrears of the credit to be negotiated
flagArrears: Indicator if the credit is in arrears or up to date
statusDesc: Response Description

responseType:

govIssueIdent: Contains user information.

govIssueIdentType: User Identification Type
identSerialNum: User Identification Number

contactInfo: Contains contact information

emailAddr: Contact email

productId: Contains product information

numProduct: Product identification number

loanInfoCommon: Contains expiration information

expDays: Expiration day

paymentAgreement: Contains payment information

idAgreement: Deal identifier
payDayNumber: Payday
amt: Value Amount Negotiation
lastPmtDt: Value Amount Negotiation

notification: Contains the message

message: Mail message

message: Response Message

desc: Message

Example

{
    "govIssueIdent": {
        "govIssueIdentType": "CC",
        "identSerialNum": "123456789"
    },
    "contactInfo": {
        "emailAddr": "prueba@gmail.com"
    },
    "productId": {
        "numProduct": "123987654"
    },
    "loanInfoCommon": {
        "expDays": "5"
    },
    "paymentAgreement": {
        "idAgreement": "1",
        "payDayNumber": "10",
        "amt": "1000000",
        "lastPmtDt": "20221205"
    },
    "notification": {
        "message": "envio de respuesta"
    },
    "message":{
        "desc": "Descripcion del mensaje"
    }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
      "value": "ER"
   },
  "responseDetail": {
      "errorCode": "00001",
      "errorDesc": "Error acuerdo de pago.",
      "errorType": "BDA"
   }
}

> Diagram of sequence.

####

##

* Register Payment Agreement:*

This operation is used to Register the payment agreement:

Request example:

/products-management/v1/payment-agreement

Body

govIssueIdent: Contains user information.

govIssueIdentType: User Identification Type
identSerialNum: User Identification Number

contactInfo:

emailAddr: Contact email

paymentAgreement: Contains payment information

idAgreement: Agreement ID
payDayNumber: Payment day number
debtIndicator: Debt indicator of a product
extAcctBal: Contains the amt field that indicates the client's salary

productId: contains the product id

numProduct: Number Product

loanInfoCommon: Loan Info Common

expDays: Expiration Day

status: Answer information

statusDesc: Answer

Example:

{
  "govIssueIdent": {
    "identSerialNum": "1234567890",
    "govIssueIdentType": "CC"
  },
  "contactInfo": {
    "emailAddr": "test@mail.com"
  },
  "paymentAgreement": {
    "idAgreement": "123455",
    "payDayNumber": "10",
    "debtIndicator": "S",
    "extAcctBal": {
      "amt": "25000000"
    }
  },
  "productId": {
    "numProduct": "123987654"
  },
  "loanInfoCommon": {
    "expDays": "15"
  },
  "status": {
    "statusDesc": "OK"
  }
}

ResponseType:

responseType: Contains response information

value: response value

responseDetail: contains response details

errorCode: response code
errorDesc: response description
errorType: response Type

Example:

{
   "responseType":{
      "value":"OK"
   },
   "responseDetail":{
      "errorCode":"00000",
      "errorDesc":"Registro Acuerdo de Pago exitoso",
      "errorType":"DBA"
   }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
      "value": "ER"
   },
  "responseDetail": {
      "errorCode": "00001",
      "errorDesc": "Error acuerdo de pago.",
      "errorType": "BDA"
   }
}

> Diagram of sequence.

####

##

* Consult Payment Agreement Parameter:*

This service allows the consultation of the parameter of a customer's payment agreement

Request example:

/products-management/v1/payment-agreement-parameter:

Query parameters

govIssueIdentType: User Identification Type
identSerialNum: User Identification Number
emailAddr: Contact Email
numProduct: Product Identification Number
expDays: expiration day of product

responseType:

loanInfoCommon: Loan info common

daysAnticipation: Parameterized days for customer consultation per day

Example

{
  "loanInfoCommon": {
    "daysAnticipation": "5"
  }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
      "value": "ER"
   },
  "responseDetail": {
      "errorCode": "00001",
      "errorDesc": "Error Consulta Parametro.",
      "errorType": "BDA"
   }
}

> Diagram of sequence.

####

##

* Consult Payment Agreement Parameter (Version 2):*

This service allows the consultation of the parameter of a customer's payment agreement version 2

Request example:

/products-management/v2/payment-agreement-parameter:

Query parameters

govIssueIdentType: Type of customer identification.
identSerialNum: Number customer Identification
emailAddr: Personal Telephone Number
numProduct: product number
expDays: Expiration day

responseType:

loanInfoCommon: Loan info common

daysAnticipation: Parameterized days for customer consultation per day

Example

{
  "loanInfoCommon": {
    "daysAnticipation": "5"
  }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
      "value": "ER"
   },
  "responseDetail": {
      "errorCode": "00001",
      "errorDesc": "Error Consulta Parametro.",
      "errorType": "BDA"
   }
}

> Diagram of sequence.

####

* Consult pre approved:*

This operation is used to Consult the pre approved:

Request example:

/products-management/v1/pre-approved

Query parameters

numProduct: Product Identification Number

ResponseType:

listPreApproved: Pre approved lists

offer: Contains the typeOffer field which indicates the type of offer
NumAsignInstallments: New Term Preapproved
amt: Fee
gracePeriod: Grace Period Number
limitDt: Deadline
quotaPercentageReduction: Percentage Reduction Fee

listCancelled: Cancelled lists

offer: Contains the typeOffer field which indicates the type of offer
limitDt: Deadline
condemnationPercentageOtherIncome: Condemnation percentage for Other Concepts
ondemnationPercentageBalanceInsurance: Condemnation percentage for Other Concepts

Example

{
  "listPreApproved": [
    {
      "offer": {
        "typeOffer": "1"
      },
      "numberOfInstallments": "Diciembre",
      "amt": "2000000",
      "gracePeriod": "4",
      "limitDt": "Octubre 14",
      "quotaPercentageReduction": "100%"
    }
  ],
  "listCancelled": [
    {
      "offer": {
        "typeOffer": "1"
      },
      "limitDt": "Octubre 14",
      "condemnationPercentageOtherIncome": "Febrero 2023",
      "condemnationPercentageBalanceInsurance": "Enero 2023"
    }
  ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
   "responseType": {
       "value": "ER"
    },
    "responseDetail": {
      "errorCode": "00001",
      "errorDesc": "consulta Fallida.",
      "errorType": "BDA"
    }
}

> Diagram of sequence.

####

##

* Consult pre approved (Version 2):*

This operation is used to Consult the pre approved version 2:

Request example:

/products-management/v2/pre-approved

Query parameters

numProduct: Product Identification Number

ResponseType:

Message: Response Message

desc: Message that is delivered to the client when they already have a current negotiation

listPreApproved: Pre approved lists

offer: Contains the typeOffer field which indicates the type of offer
NumAsignInstallments: New Term Preapproved
amt: Fee
gracePeriod: Grace Period Number
limitDt: Deadline
quotaPercentageReduction: Percentage Reduction Fee

listCancelled: Cancelled lists

offer: Contains the typeOffer field which indicates the type of offer
limitDt: Deadline
condemnationPercentageOtherIncome: Condemnation percentage for Other Concepts
condemnationPercentageBalanceInsurance: Condemnation percentage for Other Concepts
cancelAmt: Value to cancel

Example

{
  "message":{
    "desc": "Ya cuenta con una negociación activa"
  },
  "listPreApproved": [
    {
      "offer": {
        "typeOffer": "1"
      },
      "numberOfInstallments": "Diciembre",
      "amt": "2000000",
      "gracePeriod": "4",
      "limitDt": "Octubre 14",
      "quotaPercentageReduction": "100%"
    }
  ],
  "listCancelled": [
    {
      "offer": {
        "typeOffer": "1"
      },
      "limitDt": "Octubre 14",
      "condemnationPercentageOtherIncome": "Febrero 2023",
      "condemnationPercentageBalanceInsurance": "Enero 2023",
      "cancelAmt": "250000"
    }
  ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
   "responseType": {
       "value": "ER"
    },
    "responseDetail": {
      "errorCode": "00001",
      "errorDesc": "consulta Fallida.",
      "errorType": "BDA"
    }
}

> Diagram of sequence.

####

##

* Register pre approved:*

This operation is used to Register the pre approved:

Request example:

/products-management/v1/pre-approved

Body

govIssueIdent: Contains user information.

govIssueIdentType: User Identification Type
identSerialNum: User Identification Number

contactInfo: Contains contact information.

emailAddr: Contact email

productId: Contains product information.

numProduct: Product id.

offer: Offer details

estateOffer: Negotiation status
typeOffer: Negotiation type

preApprovedInfo: Pre Approved Info

curAmt: contains the field amt which indicates Capital Balance
amt: New Value Pre-approved Fee
flagNumberOfInstallments: Flag Pre-approved Term
numberOfInstallments: New Term Preapproved
gracePeriod: Grace Period Number
condemnationPercentageOtherIncome: Condemnation percentage for Other Concepts
condemnationPercentageBalanceInsurance: Condemnation percentage for Capital and Insurance Concepts
quotePercentageReduction: Percentage Reduction Fee

Example

{
  "govIssueIdent": {
    "govIssueIdentType": "CC",
    "identSerialNum": "1234567890"
  },
  "contactInfo": {
    "emailAddr": "prueba@gmail.com"
  },
  "productId": {
    "numProduct": "123987654"
  },
  "offer": {
    "estateOffer": "AP",
    "typeOffer": "Modificado"
  },
  "preApprovedInfo": {
    "curAmt":{
      "amt": "1000000"
    },
    "amt": "1000000",
    "flagNumberOfInstallments": "1",
    "numberOfInstallments": "1",
    "gracePeriod": "1",
    "condemnationPercentageOtherIncome": "1",
    "condemnationPercentageBalanceInsurance": "1",
    "quotePercentageReduction": "1"
  }
}

ResponseType:

responseType: Response type

value: Response value

responseDetail: Response details

errorCode: Code
errorDesc: Description
errorType: Type

Example

{
   "responseType":{
      "value":"OK"
   },
   "responseDetail":{
      "errorCode":"00000",
      "errorDesc":"Registro Oferta Pre Aprobado Exitoso",
      "errorType":"DBA"
   }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
   "responseType": {
       "value": "ER"
   },
  "responseDetail": {
       "errorCode": "00001",
       "errorDesc": "Error en registro de preaprovado.",
       "errorType": "DBA"
   }
}

> Diagram of sequence.

####

##

* Register pre approved (Version 2):*

This operation is used to Register the pre approved version 2:

Request example:

/products-management/v2/pre-approved

Body

govIssueIdent: Contains user information.

govIssueIdentType: User Identification Type
identSerialNum: User Identification Number

contactInfo: Contains contact information.

emailAddr: Contact email

productId: Contains product information.

numProduct: Product id.

offer: Offer details

estateOffer: Negotiation status
typeOffer: Negotiation type

preApprovedInfo: Pre Approved Info

curAmt: contains the field amt which indicates Capital Balance
amt: New Value Pre-approved Fee
flagNumberOfInstallments: Flag Pre-approved Term
numberOfInstallments: New Term Preapproved
gracePeriod: Grace Period Number
condemnationPercentageOtherIncome: Condemnation percentage for Other Concepts
condemnationPercentageBalanceInsurance: Condemnation percentage for Capital and Insurance Concepts
quotePercentageReduction: Percentage Reduction Fee
channel: Channel
obligationDt: Obligation pay date
obligationAmt: Value obligation

Example

{
  "govIssueIdent": {
    "govIssueIdentType": "CC",
    "identSerialNum": "1234567890"
  },
  "contactInfo": {
    "emailAddr": "prueba@gmail.com"
  },
  "productId": {
    "numProduct": "123987654"
  },
  "offer": {
    "estateOffer": "AP",
    "typeOffer": "Modificado"
  },
  "preApprovedInfo": {
    "curAmt":{
      "amt": "1000000"
    },
    "amt": "1000000",
    "flagNumberOfInstallments": "1",
    "numberOfInstallments": "1",
    "gracePeriod": "1",
    "condemnationPercentageOtherIncome": "1",
    "condemnationPercentageBalanceInsurance": "1",
    "quotePercentageReduction": "1",
    "channel": "007",
    "obligationDt": "20221115",
    "obligationAmt": "525000"
  }
}

ResponseType:

responseType: Response type

value: Response value

responseDetail: Response details

errorCode: Code
errorDesc: Description
errorType: Type

Example

{
   "responseType":{
      "value":"OK"
   },
   "responseDetail":{
      "errorCode":"00000",
      "errorDesc":"Registro Oferta Pre Aprobado Exitoso",
      "errorType":"DBA"
   }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
   "responseType": {
       "value": "ER"
   },
  "responseDetail": {
       "errorCode": "00001",
       "errorDesc": "Error en registro de preaprovado.",
       "errorType": "DBA"
   }
}

> Diagram of sequence.

####

##

-Cards of profile

This is related to the cards of a client.

Path:

/productsManagement/v1/cards/{identSerialNum}:

URI parameters

identSerialNum: Identification number

Query parameters

govIssueIdentType: Type of identification issued by the government of the country

flagStateProduct: Flag that indicates if all the products are consulted, or only the active ones.

Response information:

> CardAcctId

Object can have information of products of Credit cards and Debit cards.

acctId: Identifier of an account.

(For credit cards,The value has been masked, only the first 6 digits and the last 4 are visible.)

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

secObjValue: Credit card with encrypted value.

Examples (externalID/secObjValue):

{
 .
  .
   "acctId": "457022******4836",
   "acctType": "CCA",
   "secObjValue": "c8cced9ca11df3968a568ec8e1eae110",
   "externalID": "c8cced9ca11df3968a568ec8e1eae110-CCA-TCR",
  .
 .
}

{
 .
  .
   "acctId": "24519837999",
   "acctType": "DBC",
   "externalId": "24519837999-DBC-",
   .
  .
 }

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Additional response information, can be considered backend response (Credit card)

statusCode: Status account
statusDesc: Explanation associated with the statusCode
personOCStatusCode: People Status Code in Core OpenCard
personOCStatusDesc: Description of People Status Code in Core OpenCard
restructurationOCStatusCode: Restructuring Status Code in Core OpenCard
restructurationOCStatusDesc: Description of Restructuring Status Code in Core OpenCard
overdraftOCStatusCode: Status Code Overcrowding in Core OpenCard
overdraftOCStatusDesc: Description of Status Code Overcrowding in Core OpenCard
unpaidDebtOCStatusCode: Code State Wallet in Core OpenCard
unpaidDebtOCStatusDesc: Description of Code State Wallet in Core OpenCard

term: Details about an account or credit (Credit Card)

cardTypeCode: Type of credit card assignment given to the customer
renewalApproval: When the card is about to expire, it defines if the renewal approval was made
flagCCFixedTerm: Flag for activation of the fixed term for purchases exclusively for credit card
flagAutomDebit: If you have automatic debit enabled.

additionalAcctId: List with Number of Associated Accounts (Debit Card)

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

ResponseType:

responseType: Response type

value: Response value

responseDetail: Response details

errorCode: Code
errorDesc: Description
errorType: Type

Example

{
   "responseType":{
      "value":"OK"
   },
   "responseDetail":{
      "errorCode":"00000",
      "errorDesc":"Registro Oferta Pre Aprobado Exitoso",
      "errorType":"DBA"
   }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
   "responseType": {
       "value": "ER"
   },
  "responseDetail": {
       "errorCode": "00001",
       "errorDesc": "Error en registro de preaprovado.",
       "errorType": "DBA"
   }
}

> Diagram of sequence.

####

Consult Payment Plan:

Request example:

Path:

-GET

/products-management/v1/recurring-payments/{acctid}

URI parameters

acctid: Account number ,ej 24526690545 .(Required)

Query parameters

flagPmtsPlanProdType :Consultation Contract Type. (Optional, If the value is not sent, by default in the api :Current ):

- Current
- Historical

flagSavingsPlan: Id plan required only for flagPmtsPlanProdType = Historical. (Optional)

initialRegistration: Initial record for pagination, internal default value 1. (Optional, If the value is not sent, by default in the api :1)

totalRecords: Number of records. (Optional, If the value is not sent, by default in the api :40)

Response information:

This operation is used to query information related to : consult payment plan . The objects of the operation are described below:

responseType: Used to return the response type.

  value: Contains information of response type.

term: Used to return information of Automatic renewal flag.

  flagNewSavingsPlan: Contains information of Automatic renewal flag ,S: It means that it is a contract of the new scheme , N: Blank or null, it means that it is a contract from the previous schema.

resultsPagesGeneric: Used to return information of number of records returned.

  recordsXPage: Contains information of number of records returned per page.
  totalRecords: Contains information of total number of elements.

depAcctId[]: List of consult payment plan.

  value: Contains information of consecutive.
  matDt: Contains information of cutoff date.
  numberOfInstallments: Contains information of quota number.
  fee:[]  fee array,contains information on savings values.
    feeType: Contains information of feeType ,ordinary savings value ,extraordinary value savings ,expected savings value ,value saved tags.
    amt: Contains information of Savings values eg, Ordinary savings value, Extraordinary savings value, Expected savings value, Saved value .
  curAmt []: curAmt array ,contains information of account balance.
    balType: Contains information of account balance tag.
    amt: Contains information of account balance value .
  intRateInfo []: IntRateInfo array.
    rate: Contains information of final percentage.
    intRateType: Contains information of rate code 001: Prize rate ,002: Base rate.
  upDt: Contains information of rate change date.
  score: Contains information of final scoring.

> Response 200.

 {
  "responseType": {
    "value": "OK"
  },
  "term": {
    "flagNewSavingsPlan": "S"
  },
  "resultsPagesGeneric": {
    "recordsXPage": 3,
    "totalRecords": 3
  },
  "depAcctId": [
    {
      "value": "010",
      "matDt": "2022-02-05",
      "numberOfInstallments": "002",
      "fee": [
        {
          "feeType": "valorAhorroOrd",
          "amt": 5523.5
        },
        {
          "feeType": "valorAhorroExt",
          "amt": 3434.5
        },
        {
          "feeType": "valorAhorroEsperado",
          "amt": 567.5
        },
        {
          "feeType": "valorAhorrado",
          "amt": 5.50
        }
      ],
      "curAmt": [
        {
          "balType": "saldoCuenta",
          "amt": 3566356.28
        }
      ],
      "intRateInfo": [
        {
        "intRateType": "001",
        "rate": 45.10
        }
      ],
      "upDt": "2022-04-05",
      "score": "0"
    },
    {
      "value": "010",
      "matDt": "2022-05-05",
      "numberOfInstallments": "002",
      "fee": [
        {
          "feeType": "valorAhorroOrd",
          "amt": 6787.50
        },
        {
          "feeType": "valorAhorroExt",
          "amt": 7898.50
        },
        {
          "feeType": "valorAhorroEsperado",
          "amt": 345.50
        },
        {
          "feeType": "valorAhorrado",
          "amt": 34.50
        }
      ],
      "curAmt": [
        {
          "balType": "saldoCuenta",
          "amt": 675667.28
        }
      ],
      "intRateInfo": [
        {
        "intRateType": "001",
        "rate": 23.10
        }
      ],
      "upDt": "2022-08-05",
      "score": "0"
    },
    {
      "value": "010",
      "matDt": "2022-02-05",
      "numberOfInstallments": "002",
      "fee": [
        {
          "feeType": "valorAhorroOrd",
          "amt": 122.50
        },
        {
          "feeType": "valorAhorroExt",
          "amt": 1560.50
        },
        {
          "feeType": "valorAhorroEsperado",
          "amt": 105.50
        },
        {
          "feeType": "valorAhorrado",
          "amt": 10.50
        }
      ],
      "curAmt": [
        {
          "balType": "saldoCuenta",
          "amt": 797789.28
        }
      ],
      "intRateInfo": [
        {
        "intRateType": "001",
        "rate": 345.11
        }
      ],
      "upDt": "2022-07-05",
      "score": "0"
    }
  ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "00002",
        "errorDesc": "Excepción inesperada",
        "errorType": "MDW"
    }
}

> Diagram of sequence.

####

Consult Deposit AFC Accounts:

Request example:

Path:

-GET

/products-management/v1/account-transactions/{acctid}

URI parameters

acctid: Account number ,ej 24526694545 .(Required)

Query parameters

flagWithdrawalType:Consultation Contract Type. (Optional, If the value is not sent, by default in the api :withBenefit):

- withBenefit
- withoutBenefit

initialRegistration: Initial record for pagination, internal default value 1. (Optional, If the value is not sent, by default in the api :1)

Response information:

This operation is used to query information related to : consult desposit AFC accounts .. The objects of the operation are described below:

responseType: Used to return the response type.

  value: Contains information of response type.

resultsPagesGeneric: Used to return information of number of records returned.

  totalRecords: Contains information of total number of elements.
  recordsXPage: Contains information of number of records returned per page.

depAcctId[]: List of consult payment plan.

  rqUID: Contains information of consecutive.
  refId: Contains information of deal reference.
  effDt: Contains information of deposit deal date.
  lastDepDt: Contains information of last movement date.
  curAmt:  curAmt array values.
    balType: Contains information of  initial deposit amount , Deposit amount available , withholding value with initial , withholding value with available tags.
    amt: Contains information of values.
  industId: industId object.
     industNum: Contains information of employer ID.
  flagIntIndicator: Contains information of interest indicator flag , N: Deposit , S: interest

> Response 200.

 {
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "recordsXPage": 3,
    "totalRecords": 3
  },
  "depAcctId": [
    {
      "rqUID": "000000001538519",
      "refId": "APII7283328817917433",
      "effDt": "2022-02-05",
      "lastDepDt": "2022-05-05",
      "curAmt": [
        {
          "balType": "valorDepositoInicial",
          "amt": 5464.5
        },
        {
          "balType": "valorDepositoDisponible",
          "amt": 34534.28
        },
        {
          "balType": "valorRetencionConInicial",
          "amt": 345.67
        },
        {
          "balType": "valorRetencionConDisponible",
          "amt": 6786.28
        }
      ],
      "industId": {
        "industNum": "0121"
      },
      "flagIntIndicator": "N"
    },
    {
      "rqUID": "000000001338519",
      "refId": "APII7283328817915433",
      "effDt": "2022-07-05",
      "lastDepDt": "2022-07-05",
      "curAmt": [
        {
          "balType": "valorDepositoInicial",
          "amt": 68678.5
        },
        {
          "balType": "valorDepositoDisponible",
          "amt": 456.28
        },
        {
          "balType": "valorRetencionConInicial",
          "amt": 3345.67
        },
        {
          "balType": "valorRetencionConDisponible",
          "amt": 234.28
        }
      ],
      "industId": {
        "industNum": "0121"
      },
      "flagIntIndicator": "N"
    },
    {
      "rqUID": "000000002538519",
      "refId": "APII7283428816915333",
      "effDt": "2022-06-05",
      "lastDepDt": "2022-08-05",
      "curAmt": [
        {
          "balType": "valorDepositoInicial",
          "amt": 234.5
        },
        {
          "balType": "valorDepositoDisponible",
          "amt": 23.28
        },
        {
          "balType": "valorRetencionConInicial",
          "amt": 234.67
        },
        {
          "balType": "valorRetencionConDisponible",
          "amt": 45665.28
        }
      ],
      "industId": {
        "industNum": "0121"
      },
      "flagIntIndicator": "N"
    }
  ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "00011",
        "errorDesc": "Excepción ocasionada por problema en los datos.",
        "errorType": "EXP"
    }
}

> Diagram of sequence.

####

-Consolidated Profile V2

Path:

/products-management/v2/{identSerialNum}:

URI parameters

identSerialNum: Identification number

Query parameters

govIssueIdentType: Type of identification issued by the government of the country

flagStateProduct: Flag that indicates if all the products are consulted, or only the active ones.

includeTypeCertsAdHoc:: Flag that indicates if the certificate status will be returned

Response information:

responseType: Used to return the response.

govIssueIdent: Identification given by the local government.

personName: Customer information.

listProducts: List with all the products associated with the client.

It can contains the following types of objects depending on the product, the following table show how the relationship.

> DepAcctId

Object can have information of products of Savings account, Current accounts, AFC account, Count my piggy bank and Correspondent bank account.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product.

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "24026078999",
   "acctType": "SDA",
   "externalId": "24026078999-SDA-AHO",
   .
  .
 }

{
 .
  .
   "acctId": "21002787999",
   "acctType": "DDA",
   "externalID": "21002787999-DDA-CTA",
  .
 .
}

depAcctProdTypeBM: Account type code in Bank Master for following products (Savings account, Current accounts, AFC account, Count my piggy bank, Correspondent bank account)

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

term: Details about an account or credit

 flagSavingsPlan: It has a savings plan.
 flagNewSavingsPlan: New Savings plan type indicator.
 flagAutomDebit: If you have automatic debit enabled.

additionalAcctId: List with Number of Associated Accounts

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> CDAAcctId

Object can have information of products of CDTs._

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "25900000999",
   "acctType": "CDA",
   "externalId": "25900000999-CDA-CDT",
   .
  .
 }

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

additionalAcctId: List with Number of Associated Accounts

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> CardAcctId

Object can have information of products of Credit cards and Debit cards.

acctId: Identifier of an account.

(For credit cards,The value has been masked, only the first 6 digits and the last 4 are visible.)

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

secObjValue: Credit card with encrypted value.

Examples (externalID/secObjValue):

{
 .
  .
   "acctId": "457022******4836",
   "acctType": "CCA",
   "secObjValue": "c8cced9ca11df3968a568ec8e1eae110",
   "externalID": "c8cced9ca11df3968a568ec8e1eae110-CCA-TCR",
  .
 .
}

{
 .
  .
   "acctId": "24519837999",
   "acctType": "DBC",
   "externalId": "24519837999-DBC-",
   .
  .
 }

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Additional response information, can be considered backend response (Credit card)

statusCode: Status account
statusDesc: Explanation associated with the statusCode
personOCStatusCode: People Status Code in Core OpenCard
personOCStatusDesc: Description of People Status Code in Core OpenCard
restructurationOCStatusCode: Restructuring Status Code in Core OpenCard
restructurationOCStatusDesc: Description of Restructuring Status Code in Core OpenCard
overdraftOCStatusCode: Status Code Overcrowding in Core OpenCard
overdraftOCStatusDesc: Description of Status Code Overcrowding in Core OpenCard
unpaidDebtOCStatusCode: Code State Wallet in Core OpenCard
unpaidDebtOCStatusDesc: Description of Code State Wallet in Core OpenCard

term: Details about an account or credit (Credit Card)

cardTypeCode: Type of credit card assignment given to the customer
renewalApproval: When the card is about to expire, it defines if the renewal approval was made
flagCCFixedTerm: Flag for activation of the fixed term for purchases exclusively for credit card
flagAutomDebit: If you have automatic debit enabled.

additionalAcctId: List with Number of Associated Accounts (Debit Card)

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> LoandInfoCommon

Object can have information of products of Credits and Rotating credits.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "24519837999",
   "acctType": "ILA",
   "externalID": "24519837999-ILA-",
  .
 .
}

{
 .
  .
   "acctId": "24519837999",
   "acctType": "RLA",
   "externalId": "24519837999-RLA-CRT",
   .
  .
 }

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Additional response information, can be considered backend response

statusCode: Contains status Core bank master (BM)  statusDesc: Contains description Core bank master (BM).
personOCStatusCode: People Status Code in Core OpenCard (Rotating Credits).
personOCStatusDesc: Description of People Status Code in Core OpenCard (Rotating Credits).
restructurationOCStatusCode: Restructuring Status Code in Core OpenCard (Rotating Credits).
restructurationOCStatusDesc: Description of Restructuring Status Code in Core OpenCard (Rotating Credits).
overdraftOCStatusCode: Status Code Overcrowding in Core OpenCard (Rotating Credits).
overdraftOCStatusDesc: Description of Status Code Overcrowding in Core OpenCard (Rotating Credits).
unpaidDebtOCStatusCode: Code State Wallet in Core OpenCard (Rotating Credits).
unpaidDebtOCStatusDesc: Description of Code State Wallet in Core OpenCard (Rotating Credits).

term: Details about an account or credit

 flagAutomDebit: If you have automatic debit enabled.

dueDt: Payday limit

externalDueDt: External Payday limit

authSystem: Bank Authorizing System (Credit)

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> CapitalizationAcctId

Object can have information of products of Cross product.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "24519837999",
   "acctType": "CPA",
   "externalID": "24519837999-CPA-",
  .
 .
}

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: State Account
 statusDesc: Explanation associated with the statusCode

capitalizationAcctAm: Applies to capitalization titles and corresponds to the value for which the title was opened

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> InsuranceInfo

Object can have information of products of SLiberty insurance and Colmena insurance.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "24519837999",
   "acctType": "LIA",
   "externalID": "24519837999-LIA-",
  .
 .
}

{
 .
  .
   "acctId": "24519837999",
   "acctType": "CIA",
   "externalID": "24519837999-CIA-",
  .
 .
}

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: State Account
 statusDesc: Explanation associated with the bankAcctStatusCode

insuranPremiumValue: For policies, it is the value that must be paid periodically to have that insurance

totalInsurableValue: For periodic loan, it is the value that the insurer will cover in case of an accident, depending on the conditions in which the insurance was taken.

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> FiduciaryAcctId

Object can have information of products of Fiduciary Assignments.

acctId: Identifier of an account.

acctType: Account type, this value it depending of kinds of product

• SDA
• DDA
• CDA
• CCA
• ILA
• RLA
• CPA
• DBC
• LIA
• CIA
• OFA

externalId: Composite Id (acctId,acctType,macroProduct separated with -).

Examples (externalID):

{
 .
  .
   "acctId": "24519837999",
   "acctType": "OFA",
   "externalID": "24519837999-OFA-CRZ",
  .
 .
}

bankAcctStatus: Contains the description and states of People in Core OpenCard.

 bankAcctStatusCode: Contains state of People in Core OpenCard (IBCS Status Code).
 statusDesc: Contains description of People in Core OpenCard (IBCS Status Description).

additionalStatus: Contains status and description in Cora bank master.

 statusCode: Contains status Core bank master (BM)
 statusDesc: Contains description Core bank master (BM).

additionalAcctId: List with Number of Associated Accounts

productId: Used to return product identification

ledger: First classification of the type of product according to the bank's product catalog.
subLeger: Second classification of the type of product according to the bank's product catalog.
group: Third classification of the type of product according to the bank's product catalog.
productIdent: Product name identifier in the digital channel.
productIdConcat: Element used for the concatenation of the bank's product catalog.
macroProduct: Grouping macroproduct of all the products handled in the bank's catalog.

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "2",
        "errorDesc": "Error description.",
        "errorType": "CLI"
    }
}

> Diagram of sequence.

####

##

-Block Checks

Path:

PUT

/products-management/v1/stop-checks

The operation that allows to block checks related to an account

Headers

X-Invoker-Channel: Channel with which the transaction must be registered.

X-Invoker-AtmId: ATM code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-Country: Country

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-ReferencedNumber: Reference number

X-Invoker-ally: Ally

Body:

{
  "depAcctId":{
    "acctId": "21000163249"
  },
  "product":{
    "code": "01",
    "desc": "ROBO O PERDIDA",
    "depAcctTrnRec":[
      {
        "chkType": "NumeroChequeInicio",
        "chkNum": "48232"
      },
      {
        "chkType": "NumeroChequeFin",
        "chkNum": "48232"
      }
    ]
  }
}

Response information:

responseType: Used to return the response

> Response 200.

{
  "responseType": {
      "value": "OK"
  },
  "depAcctId":{
    "acctId": "21000163249"
  }
}

> Errors response example.

Aside from the error codes of the APIKit this resource only response on error code 206 for IVR channel.
{
  "responseType": {
    "value": "ER"
  },
  "responseDetail": {
    "errorCode": "00008013",
    "errorDesc": "8013- CTA - ID - CTA NO EXISTE",
    "errorType": "STP"
  }
}

##