bcs-transactions-management-api-services

API INFORMATION

Title: transactions-management-api-service

Version: 1.0.41

Protocols: HTTPS

URI Sandbox: https://transactions-management-api-services-dev.us-e1.cloudhub.io/

URI QA: https://transactions-management-api-services-qa.us-e1.cloudhub.io/

URILive:

DOWLOAD RAML

DESCRIPTION

The API will offer consumers to consult information about the transaction information about the bank's products, using criteria related to the product number, which allows the following operations:

Summary

Common headers ( all operations)

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

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-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

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-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginIdSi: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

-Accounts

Request examples:

GET

Request example 1:

[Consultation of last 20 records]

/accountsManagement/v1/trn/1577611657-SDA-AHO

Request example 2:

[Consultation of records based on startDt]

/accountsManagement/v1/trn/1577611657-SDA-AHO?startDt=2011-07-01T00:00:00.000Z

Request example 3:

[Query of transactions based on the initial record and number of records to consult]

/accountsManagement/v1/trn/1577611657? totalRecords=10&initialRegistration=21&ledger=24&subLedger=11&group=10&productType=AFC

-Uri parameters

acctId: Identifier of an account or product .(Required)

Format:

-example {acctId} - {productType} - {macroproduct}.

-example {acctId}

-Query parameters

ledger: First classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

subLedger: Second classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

group:Third classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

productType: Macro-product code, options: (Optional internal )

***Consederation for productType= AHO,CTA: If startDt is sent, and less than today's date, the API sets the search to startDt - 6 months.

- AFC  (AFC account)

- AHO (Savings account )

- CTA (Current accounts)

totalRecords: Total number of records for the response max 20, internal default value 20. (Optional)

initialRegistration: Initial record for pagination, internal default value 1 ,example 21 for the second page ,41 for the third page.. .(Optional)

startDt:Start date for filter records.

Response information:

This operation is used to query information related to : Current accounts, AFC account, Savings account transactions .. The objects of the operation are described below:

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

depAcctId: Contains information related to account products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId based on startDt + trnRqUID default uuid() )**
 desc: Contains information related  to additional transaction information.
 bankInfo: Contains information related  to  Office information.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "recordsXPage": 2
  },
  "acctId": "24599409999",
  "depAcctId": [
    {
      "selRangeDt": {
        "startDt": "2022-07-05T11:05:10.000Z"
      },
      "transaction": {
        "desc": "GRAVAMEN MOVS FINANCIEROS",
        "curAmt": {
          "amt": -637
        },
        "trnRqUID": "29716682",
        "externalId":"21ec5b5ea258151a3e995f63aa52e067"
      },
      "desc": "Aditional Info",
      "bankInfo": {
        "branchId": "320020",
        "branchName": "RESTREPO"
      },
      "originatorName": "RESTREPO"
    },
    {
      "selRangeDt": {
        "startDt": "2022-07-05T10:05:10.000Z"
      },
      "transaction": {
        "desc": "RETEFUENTE SOBRE INTERES",
        "curAmt": {
          "amt": -159367
        },
        "trnRqUID": "27716680",
        "externalId":"11ec5b5ea258151a3e995f63aa32e067"
      },
      "desc": "Aditional Info",
      "bankInfo": {
        "branchId": "320020",
        "branchName": "RESTREPO"
      },
      "originatorName": "RESTREPO"
    }
  ]
}

> 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"
    }
}

-Certificate Of Deposit (cdt)

Request example:

GET

Request example 1:

[Consultation of last 20 records]

/investmentsManagement/v1/trn/1577611657-CDA-CER

Request example 2:

[Consultation of records based on startDt]

/investmentsManagement/v1/trn/1577611657-CDA-CER?startDt=2011-07-01T10:00:00.000Z

Request example 3:

[Query of transactions based on the initial record and number of records to consult]

/investmentsManagement/v1/trn/1577611657? totalRecords=10&initialRegistration=21&ledger=24&subLedger=11&group=10&productType=CER

-Uri parameters

acctId: Identifier of an account or product .(Required)

Format:

-example {acctId} - {productType} - {macroproduct}.

-example {acctId}

-Query parameters

ledger: First classification of the type of product according to the bank's product catalog.(Optional internal default value 00)

subLedger: Second classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

group:Third classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

productType: Macro-product code, options: (Optional)

- CER (CDT Certificate of deposit)

totalRecords: Total number of records for the response max 20, internal default value 20. (Optional)

initialRegistration: Initial record for pagination, internal default value 1 ,example 21 for the second page . (Optional)

startDt:Start date for filter records.

Response information:

This operation is used to query information related to : Certificate of Deposit transactions .. The objects of the operation are described below:

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

CDAAcctId: Contains information related to certificate of deposit products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId based on md5 (startDt + amt + trnRqUID )**
 desc: Contains information related  to additional transaction information.
 bankInfo: Office information.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
      "recordsXPage": 2
    },
  "acctId": "25700009999",
  "CDAAcctId": [
    {
      "selRangeDt": {
        "startDt": "2022-06-07T01:10:30.700Z"
      },
      "transaction": {
        "desc": "APERT. CERTIF. EN EFECT.",
        "curAmt": {
          "amt": 5000000.00
        },
        "trnRqUID": "004238",
        "externalId":"13ec5b5ea258151a3e395f63aa32e067"
      },
      "desc": "Aditional info",
      "bankInfo": {
        "branchId": " 0166",
        "branchName": "NOGAL"
      },
      "originatorName": "NOGAL"
    },
        {
      "selRangeDt": {
        "startDt": "2022-04-01T00:50:70.100Z"
      },
      "transaction": {
        "desc": "APERT. CERTIF. EN EFECT.",
        "curAmt": {
          "amt": 5000000.00
        },
        "trnRqUID": "004128",
        "externalId":"13ec5b54a258151a3e395f65aa32e067"
      },
      "desc": "Aditional info",
      "bankInfo": {
        "branchId": " 0166",
        "branchName": "NOGAL"
      },
      "originatorName": "NOGAL"
    }
  ]
}

> 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"
    }
}

- Fiduciary

Request example:

GET

Request example 1:

[Consultation of last 20 records]

/investmentsManagement/v1/trn/1577611657-OFA-CRZ

Request example 2:

[Consultation of records based on startDt]

/investmentsManagement/v1/trn/1577611657-OFA-CRZ?startDt=2011-07-01T10:00:00.000Z

Request example 3:

[Query of transactions based on the initial record and number of records to consult]

/investmentsManagement/v1/trn/1577611657? totalRecords=10&initialRegistration=21&ledger=24&subLedger=11&group=10&productType=CRZ

-Uri parameters

acctId: Identifier of an account or product .(Required)

Format:

-example {acctId} - {productType} - {macroproduct}.

-example {acctId}

-Query parameters

ledger: First classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

subLedger: Second classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

group:Third classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

totalRecords: Total number of records for the response max 20, internal default value 20. (Optional)

productType: Macro-product code, options: (Optional)

- CRZ (Fiduciary)

date: Date of transaction format YYYYMMDDHHMMSS, internal default value current date of the consult .(Optional)

initialRegistration: Initial record for pagination, internal default value 1 ,example 21 for the second page . (Optional)

startDt:Start date for filter records.

Response information:

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

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

fiduaciaryAcctId: Contains information related to account products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId based on md5 (startDt + amt + trnRqUID )**
 bankInfo: Office information.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "recordsXPage": 2
  },
  "acctId": "1419990009999",
  "fiduaciaryAcctId": [
    {
      "selRangeDt": {
        "startDt": "2022-05-05T02:01:10.500Z"
      },
      "transaction": {
        "desc": "APORTES",
        "curAmt": {
          "amt": 11885533442211337781.40
        },
        "trnType": "1",
        "trnRqUID": "29716682",
        "externalId":"018f24fc0c5617c1583e154dc0516ea8"
      },
      "bankInfo": {
        "branchId": "0",
        "branchName": "OFICINA PRINCIPAL FIDUCIARIA"
      },
      "originatorName": "OFICINA PRINCIPAL FIDUCIARIA"
    },
    {
      "selRangeDt": {
        "startDt": "2022-04-01T01:03:60.800Z"
      },
      "transaction": {
        "desc": "APORTES",
        "curAmt": {
          "amt": 5100000000001.00
        },
        "trnType": "1",
        "trnRqUID": "28498521",
        "externalId":"018f22fc0c5617c1583e154dc01018f24fc0c5617c1583e154dc0516ea816ea8"
      },
      "bankInfo": {
        "branchId": "0",
        "branchName": "OFICINA PRINCIPAL FIDUCIARIA"
      },
      "originatorName": "OFICINA PRINCIPAL FIDUCIARIA"
    }
  ]
}

> 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": "00010",
        "errorDesc": "The order has no movements",
        "errorType": "LGN"
    }
}

- Loan

Request example:

GET

Request example 1:

[Consultation of last 20 records]

/loansManagement/v1/trn/1577611657-ILA-CAR

Request example 2:

[Consultation of records based on startDt]

/loansManagement/v1/trn/1577611657-ILA-CAR?startDt=2011-07-01T10:00:00.000Z

Request example 3:

[Query of transactions based on the initial record and number of records to consult]

/loansManagement/v1/trn/1577611657? totalRecords=10&initialRegistration=21&ledger=24&subLedger=11&group=10&productType=CAR

-Uri parameters

acctId: Identifier of an account or product .(Required)

Format:

-example {acctId} - {productType} - {macroproduct}.

-example {acctId}

-Query parameters

ledger: First classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

subLedger: Second classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

group:Third classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

productType: Macro-product code, options: (Optional)

- CAR  (Loan)

totalRecords: Total number of records for the response max 20, internal default value 20. (Optional)

initialRegistration: Initial record for pagination, internal default value 1 ,example 21 for the second page . (Optional)

startDt:Start date for filter records.

Response information:

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

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

loanInfoCommon: Contains information related to account products.

 selRangeDt: Contains information of transaction date.
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId based on md5 (startDt + amt  ) )**
 bankInfo: Office information.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "totalRecords": 2,
    "recordsXPage": 2
  },
  "acctId": "30009949999",
  "loanInfoCommon": [
    {
      "selRangeDt": {
        "startDt": "2022-02-25T00:00:00.001Z"
      },
      "transaction": {
        "desc": "APLIC.VALOR PENDIENTE",
        "curAmt": {
          "amt": -6764.96
        },
        "externalId":"018f24f10c5617c1583e154dc05d6ea8"
      },
      "bankInfo": {
        "branchId": "320417",
        "branchName": "BOULEVARD 58"
      },
      "originatorName": "BOULEVARD 58"
    },
    {
      "selRangeDt": {
        "startDt": "2022-02-25T00:00:00.002Z"
      },
      "transaction": {
        "desc": "PAGO NORMAL",
        "curAmt": {
          "amt": -55720000.00
        },
        "externalId":"028f24f10c5657c1583e154dc05d6ea8"
      },
      "bankInfo": {
        "branchId": "320538",
        "branchName": "CENTRAL DE CARTERA"
      },
      "originatorName": "BOULEVARD 58"
    }
  ]
}

> 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": "01403",
        "errorDesc": "NO RECORDS FOUND",
        "errorType": "LGN"
    }
}

- Revolving Credit

Request example:

GET

Request example 1:

[Consultation of last 20 records]

/loansManagement/v1/trn/1577611657-RLA-CRT

Request example 2:

[Consultation of records based on startDt]

/loansManagement/v1/trn/1577611657-RLA-CRT?startDt=2011-07-01T20:00:00.000Z

Request example 3:

[Query of transactions based on the initial record and number of records to consult]

/loansManagement/v1/trn/1577611657? totalRecords=10&initialRegistration=21&ledger=24&subLedger=11&group=10&productType=CRT

-Uri parameters

acctId: Identifier of an account or product .(Required)

Format:

-example {acctId} - {productType} - {macroproduct}.

-example {acctId}

-Query parameters

ledger: First classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

subLedger: Second classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

group:Third classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

productType: Macro-product code, options: (Optional)

- CRT (Revolving Credit)

totalRecords: Total number of records for the response max 20, internal default value 20. (Optional)

initialRegistration: Initial record for pagination, internal default value 1 ,example 21 for the second page . (Optional)

startDt:Start date for filter records.

Response information:

This operation is used to query information related to : Revolving credit transactions . The objects of the operation are described below:

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

loanInfoCommon: Contains information related to account products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId based on md5 (startDt + amt + trnRqUID ) )**
 numAsignInstallments: Contains information related  to original term of the transaction.
 bankInfo: Contains information related  to office information.
 curAmt: Contains information of Outstanding balance.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "totalElements": 3,
    "recordsXPage": 3
  },
  "acctId": "127165761122",
  "loanInfoCommon": [
    {
      "selRangeDt": {
        "startDt": "2022-08-03T11:01:10.500Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000031336404",
        "trnType": "00502",
        "desc": "IVA",
        "curAmt": {
          "amt": 0
        },
        "externalId":"128f14f10c5657c1583e154dc05d6ea8"
      },
      "numAsignInstallments": 1,
      "bankInfo": {
        "branchId": "0",
        "branchName": "BANCO CAJA SOCIAL."
      },
      "curAmt": {
        "balType": "saldoPendiente",
        "amt": 50006000800000.00
      },
      "originatorName": "BANCO CAJA SOCIAL."
    },
    {
      "selRangeDt": {
        "startDt": "2022-07-05T10:20:30.101Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000030336101",
        "trnType": "00157",
        "desc": "Cuota de Manejo cr",
        "curAmt": {
          "amt": 0
        },
        "externalId":"128f14f10c5657c1583e124dc07d6ea8"
      },
      "numAsignInstallments": 1,
      "bankInfo": {
        "branchId": "1",
        "branchName": "CANDELARIA"
      },
      "curAmt": {
        "balType": "saldoPendiente",
        "amt": 50006000800000.00
      },
      "originatorName": "CANDELARIA"
    },
    {
      "selRangeDt": {
        "startDt": "2022-01-04T09:04:01.100Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000029336404",
        "trnType": "00031",
        "desc": "Cuota de Manejo cr",
        "curAmt": {
          "amt": 0
        },
        "externalId":"md5 (startDt + amt + trnRqUID )"
      },
      "numAsignInstallments": 1,
      "bankInfo": {
        "branchId": "1",
        "branchName": "CANDELARIA"
      },
      "curAmt": {
        "balType": "saldoPendiente",
        "amt": 0
      },
      "originatorName": "CANDELARIA"
    }
  ]
}

> 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": "Unexpected error",
        "errorType": "LGN"
    }
}

- Credit Card

Request example:

GET

Request example 1:

[Consultation of last 20 records]

/cardsManagement/v1/trn/cecdea9ea716f0948a508c-CCA-TCR

Request example 2:

[Consultation of records based on startDt]

/cardsManagement/v1/trn/cecdea9ea716f0948a508c-CCA-TCR?startDt=2011-07-01T20:00:00.000Z

Request example 3:

[Query of transactions based on the initial record and number of records to consult]

/cardsManagement/v1/trn/cecdea9ea716f0948a508c? totalRecords=10&initialRegistration=21&ledger=24&subLedger=11&group=10&productType=TCR

acctId: Identifier of an account or product - encrypted format or clear format is accepted .(Required)

Format:

-example {acctId} - {productType} - {macroproduct}.

-example {acctId}

-Query parameters

ledger: First classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

subLedger: Second classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

group:Third classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

productType: Macro-product code, options: (Optional)

- TCR (Revolving Credit)

totalRecords: Total number of records for the response max 20, internal default value 20. (Optional)

initialRegistration: Initial record for pagination, internal default value 1 ,example 21 for the second page . (Optional)

startDt:Start date for filter records.

Response information:

This operation is used to query information related to : Credit card transactions . The objects of the operation are described below:

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

cardAcctId: Contains information related to account products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId based on md5 (startDt + amt + trnRqUID ) )**
 curAmt: Contains information of capital in arrears.
 extAcctBal: Contains information of remaining capital amount.
 intRateInfo: Contains information of interest and interest rate.
 numberOfPmtInstallments: Contains information related  to Credit card pending Fees.
 numAsignInstallments: Contains information related  to original term of the transaction.
 originatorName: Contains information related  to Establishment where the transaction originated.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "totalElements": 2,
    "recordsXPage": 2
  },
  "acctId": "457021******3389",
  "secObjValue": "f46626ae2ff912e81c90be3649d3be52",
  "cardAcctId": [
    {
      "selRangeDt": {
        "startDt": "2022-06-07T00:10:30.700Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000100163749",
        "desc": "PAGO INTERNET",
        "curAmt": {
          "amt": -283292.00
        },
        "externalId":"078f24fc0c561711583e154dc0516ea8"
      },
      "curAmt": {
        "baltype": "capitalEnMora",
        "amt": -10000000000009.23
      },
      "extAcctBal": {
        "extBalType": "capitalRestante",
        "curAmt": {
          "amt": 10000000000008.76
        }
      },
      "intRateInfo": [
        {
          "rate": "interes",
          "curAmt": {
            "amt": 0
          }
        },
        {
          "rate": "tasaInteres",
          "curAmt": {
            "amt": 0
          }
        }
      ],
      "numberOfPmtInstallments": 0,
      "numAsignInstallments": 0,
      "originatorName": "NEW FASHION NAILS S A S"
    },
    {
      "selRangeDt": {
        "startDt": "2022-05-01T00:15:20.600Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000100162434",
        "desc": "PAGO INTERNET",
        "curAmt": {
          "amt": -360863.00
        },
        "externalId":"018f24fc0c5617c1583e154dc06d6ea8"
      },
      "curAmt": {
        "baltype": "capitalEnMora",
        "amt": -10000000000000.00
      },
      "extAcctBal": {
        "extBalType": "capitalRestante",
        "curAmt": {
          "amt": 0
        }
      },
      "intRateInfo": [
        {
          "rate": "interes",
          "curAmt": {
            "amt": 0
          }
        },
        {
          "rate": "tasaInteres",
          "curAmt": {
            "amt": 0
          }
        }
      ],
      "numberOfPmtInstallments": 0,
      "numAsignInstallments": 0,
      "originatorName": "PAYU DAFITI"
    }
  ]
}

> 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": "00003",
        "errorDesc": "Error in the number of records to consult",
        "errorType": "LGN"
    }
}

> Diagram of sequence.

- Consult Commission Cost

Request example:

GET

/transactions-management/v1/fees

-Query parameters

processingCode: Type of commission: (Optional)

**Consider: if it is empty will return all commission types

- K_124

acctId: Account number

- 24026298191

Response information

responseType: Used to return the response type.

responseDetail: Contains information related to errors

trn: Contains information related to the commission cost

trn.processingCode:  Type of commission
trn.flagCommission: A flag that determines if the account will be excluded from charge or not
trn.desc: General Description
trn.operationType: Contains information related to the method of commission cost
trn.fee.minPmtCurAmt.amt: Contains information related to the minimum commission cost
trn.minCurAmt.amt: Minimum Transaction Cost
trn.maxCurAmt.amt: Maximum Transaction Cost
trn.fee.curAmt.amt: Contains information related to the commission cost
trn.taxPmtInfo.curAmt.amt: Tax Cost

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "trn": {
    "processingCode": "K 124",
    "flagCommission": "N",
    "desc": "REPOSICION TD A DOMICILIO",
    "operationType": "F",
    "fee": {
      "minPmtCurAmt": {
        "amt": 0
      },
      "curAmt": {
        "amt": "1215000"
      }
    },
    "minCurAmt": {
      "amt": 0
    },
    "maxCurAmt": {
      "amt": 0
    },
    "taxPmtInfo": {
      "curAmt": {
        "amt": "1900"
      }
    }
  }
}

##

- General transactions endpoint

Request example:

GET

Request examples:

[Accounts]

-[Consultation of last 20 records - format {acctId} - {productType} - {macroproduct}]

/transactions-management/v1/trn/21599404540-SDA-AFC

/transactions-management/v1/trn/24176048514-SDF-AHO

/transactions-management/v1/trn/22002457461-DDA-CTA

-[Consultation of last 20 records - format {acctId} ?productType={macro-product} ]

/transactions-management/v1/trn/22599404540?productType=AFC

/transactions-management/v1/trn/24176048514?productType=AHO

/transactions-management/v1/trn/22002457461?productType=CTA

-[Consultation of records format {acctId} - {productType} - {macroproduct} based on startDt ]

/transactions-management/v1/trn/21599404540-SDA-AFC?startDt=2022-09-10T00:00:00.000Z

/transactions-management/v1/trn/21599404540-SDF-AHO?startDt=2022-09-10T00:00:00.000Z

/transactions-management/v1/trn/21599404540-DDA-CTA?startDt=2022-09-10T00:00:00.000Z

[Certificate of deposit]

-[Consultation of last 20 records - format {acctId} - {productType} - {macroproduct}]

/transactions-management/v1/trn/35700102529-CDA-CER

-[Consultation of last 20 records - format {acctId} ?productType={macro-product} ]

/transactions-management/v1/trn/35700102529?productType=CER

-[Consultation of records format {acctId} - {productType} - {macroproduct} based on startDt ]

/transactions-management/v1/trn/35700102529-CDA-CER?startDt=2022-09-10T00:00:00.000Z

[Fiduciary]

-[Consultation of last 20 records - format {acctId} - {productType} - {macroproduct}]

/transactions-management/v1/trn/1419990003011-CDA-CRZ

-[Consultation of last 20 records - format {acctId} ?productType={macro-product} ]

/transactions-management/v1/trn/1419990003011?productType=CRZ

-[Consultation of records format {acctId} - {productType} - {macroproduct} based on startDt ]

/transactions-management/v1/trn/1419990003011-CDA-CRZ?startDt=2022-09-10T00:00:00.000Z

[Loan]

-[Consultation of last 20 records - format {acctId} - {productType} - {macroproduct}]

/transactions-management/v1/trn/1577611657-ILA-CAR

-[Consultation of last 20 records - format {acctId} ?productType={macro-product} ]

/transactions-management/v1/trn/1577611657?productType=CAR

-[Consultation of records format {acctId} - {productType} - {macroproduct} based on startDt ]

/transactions-management/v1/trn/1577611657-ILA-CAR?startDt=2022-09-10T00:00:00.000Z

[Revolving Credit]

-[Consultation of last 20 records - format {acctId} - {productType} - {macroproduct}]

/transactions-management/v1/trn/1577611657-RLA-CRT

-[Consultation of last 20 records - format {acctId} ?productType={macro-product} ]

/transactions-management/v1/trn/?productType=CRT

-[Consultation of records format {acctId} - {productType} - {macroproduct} based on startDt ]

/transactions-management/v1/trn/1577611657-RLA-CRT?startDt=2022-09-10T00:00:00.000Z

[Credit Card ]

-[Consultation of last 20 records - format {acctId} - {productType} - {macroproduct}]

/transactions-management/v1/trn/ceadea9ea716f0948a508c-CCA-TCR

-[Consultation of last 20 records - format {acctId} ?productType={macro-product} ]

/transactions-management/v1/trn/ceadea9ea716f0948a508c?productType=TCR

-[Consultation of records format {acctId} - {productType} - {macroproduct} based on startDt ]

/transactions-management/v1/trn/ceadea9ea716f0948a508c-CCA-TCR?startDt=2022-09-10T00:00:00.000Z

-Uri parameter

acctId: Identifier of an account or product - encrypted format or clear format is accepted .(Required)

Format examples:

• {acctId} - {productType} - {macroproduct} ej. 22002457461-DDA-CTA
• {acctId} ej. 22002457461

-Query parameters

productType: Macro-product code, options: (Optional)

***Consederation for productType= AHO,CTA: If startDt is sent, and the parameter is greater than two days, the API sets the search to today() - 2 Days.

- AFC (AFC account) ***
- AHO (Savings account ) ***
- CTA (Current accounts)
- CER (CDT Certificate of deposit)
- CRZ (Fiduciary)
- CAR (Loan)
- CRT (Revolving Credit)
- TCR (Revolving Credit)

ledger: First classification of the type of product according to the bank's product catalog.(Optional internal default value 00)

subLedger: Second classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

group:Third classification of the type of product according to the bank's product catalog. (Optional internal default value 00)

totalRecords: Total number of records for the response max 20, internal default value 20. (Optional)

initialRegistration: Initial record for pagination, internal default value 1 ,example 21 for the second page . (Optional)

startDt:Start date for filter records (ej 2016-01-28T00:00:00.000Z). (Optional)

Response information

The response information is the same as previously defined in :

-Accounts

Information related to : Current accounts (CTA), AFC account, Savings account transactions (AHO) .. The objects of the operation are described below:

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

depAcctId: Contains information related to account products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId  based on md5 (startDt + amt + trnRqUID ) )**
 desc: Contains information related  to additional transaction information.
 bankInfo: Contains information related  to  Office information.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "recordsXPage": 2
  },
  "acctId": "24599409999",
  "depAcctId": [
    {
      "selRangeDt": {
        "startDt": "2022-07-05T11:05:10.000Z"
      },
      "transaction": {
        "desc": "GRAVAMEN MOVS FINANCIEROS",
        "curAmt": {
          "amt": -637
        },
        "trnRqUID": "29716682",
        "externalId":"21ec5b5ea258151a3e995f63aa52e067"
      },
      "desc": "Aditional Info",
      "bankInfo": {
        "branchId": "320020",
        "branchName": "RESTREPO"
      },
      "originatorName": "RESTREPO"
    },
    {
      "selRangeDt": {
        "startDt": "2022-07-05T10:05:10.000Z"
      },
      "transaction": {
        "desc": "RETEFUENTE SOBRE INTERES",
        "curAmt": {
          "amt": -159367
        },
        "trnRqUID": "27716680",
        "externalId":"11ec5b5ea258151a3e995f63aa32e067"
      },
      "desc": "Aditional Info",
      "bankInfo": {
        "branchId": "320020",
        "branchName": "RESTREPO"
      },
      "originatorName": "RESTREPO"
    }
  ]
}

-Certificate Of Deposit

This operation is used to query information related to : Certificate of Deposit transactions . The objects of the operation are described below:

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

CDAAcctId: Contains information related to certificate of deposit products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId  based on md5 (startDt + amt + trnRqUID ) )**
 desc: Contains information related  to additional transaction information.
 bankInfo: Office information.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
      "recordsXPage": 2
    },
  "acctId": "25700009999",
  "CDAAcctId": [
    {
      "selRangeDt": {
        "startDt": "2022-06-07T01:10:30.700Z"
      },
      "transaction": {
        "desc": "APERT. CERTIF. EN EFECT.",
        "curAmt": {
          "amt": 5000000.00
        },
        "trnRqUID": "004238",
        "externalId":"13ec5b5ea258151a3e395f63aa32e067"
      },
      "desc": "Aditional info",
      "bankInfo": {
        "branchId": " 0166",
        "branchName": "NOGAL"
      },
      "originatorName": "NOGAL"
    },
        {
      "selRangeDt": {
        "startDt": "2022-04-01T00:50:70.100Z"
      },
      "transaction": {
        "desc": "APERT. CERTIF. EN EFECT.",
        "curAmt": {
          "amt": 5000000.00
        },
        "trnRqUID": "004128",
        "externalId":"13ec5b54a258151a3e395f65aa32e067"
      },
      "desc": "Aditional info",
      "bankInfo": {
        "branchId": " 0166",
        "branchName": "NOGAL"
      },
      "originatorName": "NOGAL"
    }
  ]
}

-Fiduciary

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

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

fiduaciaryAcctId: Contains information related to account products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId based on md5 (startDt + amt + trnRqUID )**
 bankInfo: Office information.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "recordsXPage": 2
  },
  "acctId": "1419990009999",
  "fiduaciaryAcctId": [
    {
      "selRangeDt": {
        "startDt": "2022-05-05T02:01:10.500Z"
      },
      "transaction": {
        "desc": "APORTES",
        "curAmt": {
          "amt": 11885533442211337781.40
        },
        "trnType": "1",
        "trnRqUID": "29716682",
        "externalId":"018f24fc0c5617c1583e154dc0516ea8"
      },
      "bankInfo": {
        "branchId": "0",
        "branchName": "OFICINA PRINCIPAL FIDUCIARIA"
      },
      "originatorName": "OFICINA PRINCIPAL FIDUCIARIA"
    },
    {
      "selRangeDt": {
        "startDt": "2022-04-01T01:03:60.800Z"
      },
      "transaction": {
        "desc": "APORTES",
        "curAmt": {
          "amt": 5100000000001.00
        },
        "trnType": "1",
        "trnRqUID": "28498521",
        "externalId":"018f22fc0c5617c1583e154dc01018f24fc0c5617c1583e154dc0516ea816ea8"
      },
      "bankInfo": {
        "branchId": "0",
        "branchName": "OFICINA PRINCIPAL FIDUCIARIA"
      },
      "originatorName": "OFICINA PRINCIPAL FIDUCIARIA"
    }
  ]
}

-Loan

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

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

loanInfoCommon: Contains information related to account products.

 selRangeDt: Contains information of transaction date.
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId based on md5 (startDt + amt  ) )**
 bankInfo: Office information.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "totalRecords": 2,
    "recordsXPage": 2
  },
  "acctId": "30009949999",
  "loanInfoCommon": [
    {
      "selRangeDt": {
        "startDt": "2022-02-25T00:00:00.001Z"
      },
      "transaction": {
        "desc": "APLIC.VALOR PENDIENTE",
        "curAmt": {
          "amt": -6764.96
        },
        "externalId":"018f24f10c5617c1583e154dc05d6ea8"
      },
      "bankInfo": {
        "branchId": "320417",
        "branchName": "BOULEVARD 58"
      },
      "originatorName": "BOULEVARD 58"
    },
    {
      "selRangeDt": {
        "startDt": "2022-02-25T00:00:00.002Z"
      },
      "transaction": {
        "desc": "PAGO NORMAL",
        "curAmt": {
          "amt": -55720000.00
        },
        "externalId":"028f24f10c5657c1583e154dc05d6ea8"
      },
      "bankInfo": {
        "branchId": "320538",
        "branchName": "CENTRAL DE CARTERA"
      },
      "originatorName": "BOULEVARD 58"
    }
  ]
}

-Revolving Credit

This operation is used to query information related to : Revolving credit transactions . The objects of the operation are described below:

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

loanInfoCommon: Contains information related to account products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId  based on md5 (startDt + amt + trnRqUID ) )**
 numAsignInstallments: Contains information related  to original term of the transaction.
 bankInfo: Contains information related  to office information.
 curAmt: Contains information of Outstanding balance.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "totalElements": 3,
    "recordsXPage": 3
  },
  "acctId": "1577611657461112",
  "loanInfoCommon": [
    {
      "selRangeDt": {
        "startDt": "2022-08-03T11:01:10.500Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000031336404",
        "trnType": "00502",
        "desc": "IVA",
        "curAmt": {
          "amt": 0
        },
        "externalId":"128f14f10c5657c1583e154dc05d6ea8"
      },
      "numAsignInstallments": 1,
      "bankInfo": {
        "branchId": "0",
        "branchName": "BANCO CAJA SOCIAL."
      },
      "curAmt": {
        "balType": "saldoPendiente",
        "amt": 50006000800000.00
      },
      "originatorName": "BANCO CAJA SOCIAL."
    },
    {
      "selRangeDt": {
        "startDt": "2022-07-05T10:20:30.101Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000030336101",
        "trnType": "00157",
        "desc": "Cuota de Manejo cr",
        "curAmt": {
          "amt": 0
        },
        "externalId":"128f14f10c5657c1583e124dc07d6ea8"
      },
      "numAsignInstallments": 1,
      "bankInfo": {
        "branchId": "1",
        "branchName": "CANDELARIA"
      },
      "curAmt": {
        "balType": "saldoPendiente",
        "amt": 50006000800000.00
      },
      "originatorName": "CANDELARIA"
    },
    {
      "selRangeDt": {
        "startDt": "2022-01-04T09:04:01.100Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000029336404",
        "trnType": "00031",
        "desc": "Cuota de Manejo cr",
        "curAmt": {
          "amt": 0
        },
        "externalId":"md5 (startDt + amt + trnRqUID )"
      },
      "numAsignInstallments": 1,
      "bankInfo": {
        "branchId": "1",
        "branchName": "CANDELARIA"
      },
      "curAmt": {
        "balType": "saldoPendiente",
        "amt": 0
      },
      "originatorName": "CANDELARIA"
    }
  ]
}

-Credit Card

This operation is used to query information related to : Credit card transactions . The objects of the operation are described below:

responseType: Used to return the response type.

resultsPagesGeneric: Contains information of number of Records Returned.

acctId: Identifier of an account.

cardAcctId: Contains information related to account products.

 selRangeDt: Contains information of transaction date* ( startDt: format hh-mm-ss-ms conversion factor based on trnRqUID)).
 transaction: Contains information related  to transaction. (Includes the unique identifier of each transaction called externalId  based on md5 (startDt + amt + trnRqUID ) )**
 curAmt: Contains information of capital in arrears.
 extAcctBal: Contains information of remaining capital amount.
 intRateInfo: Contains information of interest and interest rate.
 numberOfPmtInstallments: Contains information related  to Credit card pending Fees.
 numAsignInstallments: Contains information related  to original term of the transaction.
 originatorName: Contains information related  to Establishment where the transaction originated.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "totalElements": 2,
    "recordsXPage": 2
  },
  "acctId": "457021******3389",
  "secObjValue": "f46626ae2ff912e81c90be3649d3be52",
  "cardAcctId": [
    {
      "selRangeDt": {
        "startDt": "2022-06-07T00:10:30.700Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000100163749",
        "desc": "PAGO INTERNET",
        "curAmt": {
          "amt": -283292.00
        },
        "externalId":"078f24fc0c561711583e154dc0516ea8"
      },
      "curAmt": {
        "baltype": "capitalEnMora",
        "amt": -10000000000009.23
      },
      "extAcctBal": {
        "extBalType": "capitalRestante",
        "curAmt": {
          "amt": 10000000000008.76
        }
      },
      "intRateInfo": [
        {
          "rate": "interes",
          "curAmt": {
            "amt": 0
          }
        },
        {
          "rate": "tasaInteres",
          "curAmt": {
            "amt": 0
          }
        }
      ],
      "numberOfPmtInstallments": 0,
      "numAsignInstallments": 0,
      "originatorName": "NEW FASHION NAILS S A S"
    },
    {
      "selRangeDt": {
        "startDt": "2022-05-01T00:15:20.600Z"
      },
      "transaction": {
        "trnSrc": "009",
        "trnRqUID": "000100162434",
        "desc": "PAGO INTERNET",
        "curAmt": {
          "amt": -360863.00
        },
        "externalId":"018f24fc0c5617c1583e154dc06d6ea8"
      },
      "curAmt": {
        "baltype": "capitalEnMora",
        "amt": -10000000000000.00
      },
      "extAcctBal": {
        "extBalType": "capitalRestante",
        "curAmt": {
          "amt": 0
        }
      },
      "intRateInfo": [
        {
          "rate": "interes",
          "curAmt": {
            "amt": 0
          }
        },
        {
          "rate": "tasaInteres",
          "curAmt": {
            "amt": 0
          }
        }
      ],
      "numberOfPmtInstallments": 0,
      "numAsignInstallments": 0,
      "originatorName": "PAYU DAFITI"
    }
  ]
}

- Consult Historical transactions

Description: Resource that allows you to consult the history of transactions made by the client associated with payments for public services, mobile recharges and transfers to third parties.

Request example

Method: [POST]

/transactions-management/v1/trn/historical-records

Headers:

-headers-invoker

-headers-security

> Request body information:

Supported transactions :

 transaction:
      trnType: Contains information related to code of the transaction to be consulted according to the list of Transactions defined  eg: (Required)
              100009 : Transferencia entre Cuentas Propias
              100032 : Transferencia Interbancarias
              100022 : Avance Tarjeta de Crédito
              100018 : Uso de Crédito Rotativo
              100185 : Transferencia de Cuenta Ahorro Transaccional hacia Bolsillo
              100038 : Transferencia de Bolsillo hacia Cuenta Ahorro Transaccional
              100084 : Transferencia desde Cuenta hacia Fondo de Inversión
              100039 : Transferencia desde Fondo de Inversión hacia Cuenta
              100053 : Pago de Créditos de Terceros BCS
              100054 : Pago de Tarjeta de Crédito de Terceros BCS
              100056 : Pago de Crédito Rotativo de Crédito de Terceros BCS
              100055 : Recarga de Celular
              100013 : Pago de Servicios *
              100034 : Pago de PSE
              100111 : Pago MiniSitio MiPagoAmigo
              900001 : Tranferencias interbancarias y transferencias a terceros
 filter[]:  Max = 10
      name: Contains information related to Name of the filter to apply ej. (Optional)
            - destinationBank (internal service value : BANCO_DESTINO )
            - destinationAccountType ( internal service value : TIPO_CUENTA_DESTINO )
            - recipientName ( internal service value : NOMBRE_DESTINATARIO )
      value: Contains information related to value associated with the name of the filter to be applied. (Optional)
depAcctId[]: (Optional)
      acctId: Contains information related to origin account number. (Optional)
      sequence:  Contains information related to Source Count Sequence. (Optional)

govIssueIdent:
      govIssueIdentType:  Contains information of  type of customer identification [PE,PA,TI,CC,NI,CE] (* if the value is not sent , the api gets the value from X-Invoker-User ) (Optional)
      identSerialNum:  Contains information of number customer Identification (* if the value is not sent , the api gets the value from X-Invoker-User ) (Optional)

resultsPagesGeneric:
       initialRecord: Initial record for pagination (if the value is not sent internal default value 1 ) Max value = 999 . (Optional)
       totalRecords: Number of records requested  , (if the value is not sent internal default value 20) Max value = 20.  (Optional)

> Request body example trnType 100013 .

{
  "transaction": {
    "trnType": "100013"
  },
  "resultsPagesGeneric": {
    "initialRecord": 1,
    "totalRecords": 5
  }
}

####

> Response body information:

 responseType:
      value: Contains information of Reponse type
 resultsPagesGeneric:
     recordsXPage: Contains information of number of records returned per page.
     totalRecords: Contains information of Total number of elements.
 transaction[]:
     trnRquId: Contains information of transaction code returned by the backend.
     depAcctId:
           amt: Contains information of value of the payment made.
           secObjValue: Contains information of Credit card with encrypted value only when transaction.trnType = 100022 in the request
           acctId: Contains information of source product code.
     pmtReferences[]:
           name: Contains information related to transaction data name
           value: Contains information related to transaction data value.

> Response body example 200

{
    "responseType": {
        "value": "OK"
    },
    "resultsPagesGeneric": {
        "recordsXPage": 2,
        "totalRecords": 20
    },
    "transaction": [
        {
            "trnRquId": "APII3198324900284449",
            "depAcctId": {
                "amt": 2500.00,
                "secObjValue": "",
                "acctId": "24026781972"
            },
            "pmtReferences": [
                {
                    "name": "FECHA_TX",
                    "value": "2023-07-17"
                },
                {
                    "name": "NOMBRE_CONVENIO",
                    "value": "COLEGIO GLENN DOMAN                               "
                },
                {
                    "name": "CODIGO_CONVENIO",
                    "value": "15965609"
                },
                {
                    "name": "REFERENCIA_1",
                    "value": "6796"
                },
                {
                    "name": "REFERENCIA_2",
                    "value": "585"
                }
            ]
        },
        {
            "trnRquId": "APII3192320505925642",
            "depAcctId": {
                "amt": 18000.00,
                "secObjValue": "",
                "acctId": "24026781972"
            },
            "pmtReferences": [
                {
                    "name": "FECHA_TX",
                    "value": "2023-07-11"
                },
                {
                    "name": "NOMBRE_CONVENIO",
                    "value": "ACEIT DOS                                         "
                },
                {
                    "name": "CODIGO_CONVENIO",
                    "value": "15965657"
                },
                {
                    "name": "REFERENCIA_1",
                    "value": "56656"
                }
            ]
        }
    ]

####

** The data list will bring the following keys for : 100013-Pago de Servicios

> 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": "00003",
        "errorDesc": "Error in the number of records to consult",
        "errorType": "LGN"
    }
}

> Diagram of sequence.

- Consult Product Balance Detail

Description: Resource that allows the consultation of a list of a client's products by means of the type and product number of each of the products .

Request example

Method: [POST]

/transactions-management/v1/balance

Headers:

-headers-invoker

-headers-security

> Request body information:

 listAccounts []: Contains information of listAccounts array

      acctType: Contains information of product type (Required).
                - AHO : Savings accounts
                - CTE : Checking accounts
                - FID : Fiduciary orders.
                - TCR : Credit card .
                - CRT : Revolving Credit .

      acctId: Contains information of product number , for acctType = TCR is allowed encrypted acctId (Required).
      workingDayFrame: Contains information of the working day ,** only for acctType=FID ** (Optional).
(Optional).
      operationMode: Contains information of operation mode ,default value online ,** only for acctType=FID ** (Optional).

> Request body example .

{
  "listAccounts": [
    {
      "acctType": "TCR",
      "acctId": "cecdea9ea716f0948a508c"
    },
    {
      "acctType": "CTE",
      "acctId": "434564456"
    },
    {
      "acctType": "AHO",
      "acctId": "5566767678678"
    }
  ]
}

####

> Response body information:

 responseType:
      value: Contains information of Reponse type
 listAccounts []:
      acctId:Contains information of product number
      acctBal [] :Contains information of balance available space array
              balType:  Contains information of balance available space tag.
              amt: Contains information of balance available space amount.

      curAmt []: Contains information of Pocket Balance and Available Balance array.
              balType: Contains information of Pocket Balance and Available Balance tags .
              amt: Contains information of balance available space amount.
      responseType:
              value: Contains information of Reponse value
      responseDetail:
              errorCode: Error code .
              errorDesc: Error description.
              errorType: Error type.

> Response body example 200

{
  "responseType": {
    "value": "OK"
  },
  "listAccounts": [
    {
      "acctId": "43675757566",
      "acctBal": [
        {
          "balType": "cupoDisponible",
          "amt": 15000
        }
      ],
      "curAmt": [
        {
          "balType": "saldoBolsillo",
          "amt": 1800
        },
        {
          "balType": "saldoDisponible",
          "amt": 19000
        }
      ],
      "responseType": {
        "value": "OK"
      },
      "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
      }
    },
    {
      "acctId": "566786868678",
      "acctBal": [
        {
          "balType": "cupoDisponible",
          "amt": 18000
        }
      ],
      "curAmt": [
        {
          "balType": "saldoBolsillo",
          "amt": 1200
        },
        {
          "balType": "saldoDisponible",
          "amt": 20000
        }
      ],
      "responseType": {
        "value": "OK"
      },
      "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
      }
    },
    {
      "acctId": "566786868678",
      "acctBal": [
        {
          "balType": "cupoDisponible",
          "amt": 0
        }
      ],
      "curAmt": [
        {
          "balType": "saldoBolsillo",
          "amt": 0
        },
        {
          "balType": "saldoDisponible",
          "amt": 0
        }
      ],
      "responseType": {
        "value": "ER"
      },
      "responseDetail": {
        "errorCode": "00001",
        "errorDesc": "Error Obteniendo el Ledger del producto en StarClientes",
        "errorType": "BDD"
      }
    }
  ]
}

> 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": "00003",
        "errorDesc": "Error in the number of records to consult",
        "errorType": "LGN"
    }
}

> Diagram of sequence.