bcs-investments-management-api-services

API INFORMATION

Title: bcs-investments-management-api-services

Version: 1.0.8

Protocols: HTTPS

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

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

URI Live: https://investments-management-api-services-prod.us-e1.cloudhub.io/investments-management/v1

DOWLOAD RAML

DESCRIPTION

This api allows the consumers to create, update and cancel a fiduciary assignment, also to get the holders.:

Summary

-Open a Fiduciary Assignment.

Description: This resource manage the operation Open a Fiduciary Assignment.

Path:

POST /investments-management/v1/fiduciary-assignment

Request information:

  fiduciaryAcctId:
    trnRqUID: Transaction ID
    processDate: Process datetime
    workingDayFrame: Type of working day frame (N:Normal, A:Adicional)
    originResources: Origin of the resources (1:Renta, 2:Salario, 3:Venta de activos, 4:Ahorros, 5:Otros)
    conditionInfo:
      condition: Type of handle conditions   (I: Individual, C:Conjunto, A:Alternativo)
    inkStamp: Wet Stamp (Sellos húmedos)
    embossedSeal: Dry Stamp (Sellos secos)
    flagProtect: Protector flag (S:Sí, N:No)
    signatureData:
      number: Number of required signs
    addr1: Product Address
    cityId: City ID
    phoneNum: Product Phone Number
    emailAddr: Product Email Address
    productType: Linked Account Type (CH:Ahorros, CC:Corriente)
    acctId: Linked Account Number
    retefuenteTaxSource: Exempt from withholding account
  custInfo(is an array minimum of one to a maximum of 4):
    custIdentType: Customer Itentification type (CC: Citizenship Card, CE: Immigration ID, PA: Passport, IT: Identity card, NI: NIT, PE: Special Stay Permit (for Venezuelans))
    custIdentNum: Identification number
    personName:
      firstName: Holder first name
      middleName: Holder second name
      lastName: Holder first last name
      secondLastName: Holder second last name

Request example

{
  "fiduciaryAcctId":{
    "trnRqUID":"APII3030327535935175",
    "processDate":"2024053164351",
    "workingDayFrame":"N",
    "originResources":2,
    "conditionInfo":{
      "condition":"I"
    },
    "inkStamp":0,
    "embossedSeal":0,
    "flagProtect":"N",
    "signatureData":{
      "number":1
    },
    "addr1":"KR 50 35 13",
    "cityId":"11001",
    "phoneNum":"3104510236",
    "emailAddr":"cc3158746@bancocajasocial.com",
    "productType":"CH",
    "acctId":"21002782747",
    "retefuenteTaxSource":"N"
  },
  "custInfo": [
    {
      "custIdentType":"CC",
      "custIdentNum":"9066933",
      "personName":{
        "firstName":"GERMAN",
        "middleName":"RICARDO",
        "lastName":"RODRIGUEZ",
        "secondLastName":"LEON"
      }
    },
    {
      "custIdentType":"CC",
      "custIdentNum":"3056441",
      "personName":{
        "firstName":"PUBLIO",
        "middleName":"BETULIA",
        "lastName":"CUCUNUBA",
        "secondLastName":"CONEO"
      }
    },
    {
      "custIdentType":"CC",
      "custIdentNum":"3056442",
      "personName":{
        "firstName":"JOSE",
        "middleName":"ROMAN",
        "lastName":"ALBA",
        "secondLastName":"CUEVAS"
      }
    }
  ]
}

Response information:

> Response 201.

{
  "responseType": {
    "value": "OK"
  },
  "fiduciaryAcctId":{
    "additionalAcctId":"1299020002326",
    "fullName":"EMILIO MARIO CIFUENTES OSPINA"
  }
}

> Response Error.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
  "responseType": {
    "value": "ER"
  },
  "responseDetail": {
    "errorCode": "00001",
    "errorDesc": "Error en el proceso de validacion de cuenta",
    "errorType": "TPS"
  }
}

> Diagram of sequence.

####

####

Error codes.

-Update a Fiduciary Assignment.

Description: This resource manage the operation update a fiduciary assignment.

Path:

PUT /investments-management/v1/fiduciary-assignment

Request information:

  fiduciaryAcctId:
    trnRqUID: Transaction ID
    processDate: Process datetime
    workingDayFrame: Type of working day frame (N:Normal, A:Adicional)
    additionalAcctId: Fiduciary assignment ID
    addr1: Product Address
    cityId: City ID
    phoneNum: Product Phone Number
    emailAddr: Product Email Address

Response information:

> Response 201.

{
  "responseType": {
    "value": "OK"
  },
  "custInfo": {
    "upDt":"20230223150540"
  }
}

> Response Error.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
  "responseType": {
    "value": "ER"
  },
  "responseDetail": {
    "errorCode": "00001",
    "errorDesc": "La longitud del mensaje de entrada no es correcta",
    "errorType": "CFS"
  }
}

> Diagram of sequence.

####

####

Error codes.

-Get Holders of a Fiduciary Assignment.

Description: This resource returns the Fiduciary Assignment Holders.

Path:

GET /investments-management/v1/fiduciary-assignment/{acctid}

URI parameters

acctid: Account Id.

Response information:

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "fiduciaryAcctId":{
    "retefuenteTaxSource":"N",
    "conditionInfo":{
      "condition":"A"
    },
    "inkStamp":0,
    "embossedSeal":0,
    "flagProtect":"N",
    "signatureData":{
      "number":1
    }
  },
  "custInfo": [
    {
      "personType": "N",
      "custIdentType": "CC",
      "custIdentNum": "3158746",
      "personName": {
        "firstName": "GERMAN",
        "middleName": "RICARDO",
        "lastName": "RODRIGUEZ",
        "secondLastName": "LEON"
      },
      "upDt": "20230130"
    },
    {
      "personType": "J",
      "custIdentType": "CH",
      "custIdentNum": "40985036",
      "personName": {
        "firstName": "PUBLIO",
        "middleName": "BETULIA",
        "lastName": "CUCUNUBA",
        "secondLastName": "CONEO"
      },
      "upDt": "20230131"
    }
  ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
  "responseType": {
    "value": "ER"
  },
  "responseDetail": {
    "errorCode": "00001",
    "errorDesc": "No se encontraron titulares para la cuenta",
    "errorType": "RNE"
  }
}

> Diagram of sequence.

####

####

Error codes.

-Cancel Fiduciary Assignment.

Description: This resource allows to cancel a fiduciary assignment.

Path:

DELETE /investments-management/v1/fiduciary-assignment

Request information:

  fiduciaryAcctId:
    trnRqUID: Transaction ID
    processDate: Process datetime
    workingDayFrame: Type of working day frame (N:Normal, A:Adicional)
    additionalAcctId: Fiduciary assignment ID
    cancelReason: Cancel reason (Compra de vehículo, Vacaciones, Necesidad de los recursos, Compra de vivienda, Rentabilidad)
    productType: Linked Account Type
    xferInfo:
      depAcctId:
        acctId: Linked Account Number
  custInfo:
    custIdentType: Identification type
    custIdentNum: Identification number
    personName:
      fullName: Holder full name

Response information:

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "fiduciaryAcctId":{
    "desc":"Transaccion Exitosa"
  }
}

> Response Error.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
  "responseType": {
    "value": "ER"
  },
  "responseDetail": {
    "errorCode": "00002",
    "errorDesc": "Fecha de sistema no corresponde a la fecha permitida. Fecha",
    "errorType": "PRA"
  }
}

> Diagram of sequence.

####

####

Error codes.

-