bcs-customers-management-sys

API INFORMATION

Title: customers-management-sys

Version: 1.0.0

Protocols: HTTPS

URI Sandbox: [https://apis.dev.bancocajasocial.co/customers-management/v1]

URI QA: [https://apis.noprod.bancocajasocial.co/customers-management/v1]

URILive: [https://apis.bancocajasocial.co/customers-management/v1]

DESCRIPTION

This service allows Management of customers-management-sys Information, which allows the following operations:

Summary

- Validation-Customer (GET):

Description:

Operation Validation of existing client in the bank

Path:

/customers-management/v1/customer/{mnemonic}/validation:

Uri Parameters

Query parameters

Headers:

Mapping Response OK

Mapping Response Error

- Authentication

Description:

This method allows the client to be authenticated with the Bank by validating the credentials sent in the incoming message.

Path:

POST: /customers-management/v1/customer/authentication:

Request Data:

Headers:

Canonical Request Body:

Request Example:

 {
    "govIssueIdent" : {
      "mnemonic" : "CC10196070"
    },
    "custPswdInfo" : {
        "cryptPswd" : "1234",
        "pswdInfo" : {
            "type" : "Biometric"
          },
        "transaction" : {
            "trnType" : "FirstTime",
            "cryptPswd" : "1234",
            "code" : "1234"
          }
      }
  }

Canonical Response Body:

Success Response Example:

{
    "responseType": {
        "value": "OK"
    },
    "personInfo": {
      "fullName": "example",
      "govIssueIdent": {
        "govIssueIdentType": "CC",
        "identSerialNum": "123123"
      },
      "lastTrnDt": ""
    }
  }

Response Error Example:

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

Diagram of sequence.

- Form

Description:

This method allows you to consult the basic information of a client (natural or legal person) for entering the registration of a business form.

Path:

GET: /customers-management/v1/trade/{mnemonic}/form:

Request Data:

Headers:

Uri Params:

Canonical Response Body:

Success Response Example:

{
  "responseType": {
    "value": "OK"
  },
  "personInfo": {
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "1234567890"
    },
    "contactInfo": {
      "cellphone": "1234567890",
      "phone": "1234567899",
      "emailAddr": "yotengogmail@gmail.com"
    },
    "postAddr": {
      "country": "Colombia",
      "cityId": "63470",
      "stateProv": "63000"
    },
    "names": "JACINTA KAREM",
    "lastName": "LUCAS HERMOSA"
  },
  "businessInfo": {
    "govIssueIdent": {
      "govIssueIdentType":"CC",
      "identSerialNum": "1234567890"
    },
    "personName": {
      "fullName": "abcs advance"
    },
    "postAddr": {
      "Addr1": "avenida patria 15b"
    }
  }
}

Response Error Example:

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

Diagram of sequence.

- Register(create) a new key (POST):

Description:

This endpoint will register a new key and associate the user and account data in a single request.

Path:

/customers-management/v1/transfiya/entity:

Request Data:

Headers:

Request Example:

{
  "transaction": {
    "idItem": "c4e6bd04-5149-11e7-b114-12654765af2f"
  },
  "personInfo": {
    "personName": {
      "firstName": "6011341540651850",
      "middleName": "6011341540651850",
      "lastName": "6011341540651850",
      "secondLastName": "6011341540651850"
    },
    "govIssueIdent": {
      "identSerialNum": "1234567890",
      "govIssueIdentType": "CC"
    },
    "personType": "PN"
  },
  "entpr": {
    "entprDesc": "Ruby Maxwell"
  },
  "depAcctId": {
    "acctType": "INCLUSIVE_LOW_AMOUNT",
    "acctId": "6011341540651850",
    "bankId": "1020",
    "signInfo": {
      "value": "6011341540651850"
    }
  },
  "cryptSecret": {
    "contentType": "ID",
    "type": "TFY",
    "value": "guh"
  }
}

Success Response Example:

// Pendiente Validar
{
  "transaction": {
    "trnRqUid": "c4e6bd04-5149-11e7-b114-a2f933d5fe66",
    "origDt": "2017-07-21T17:32:28.000Z",
    "rquId": "acxff62e-6f12-42de-9012-1e7304418abd"
  },
  "custStatus": {
    "idItem": "d8ad8825-5cdf-5316-b791-018dee8e2c56",
    "type": "MERCHANTID",
    "value": "76.71",
    "cryptSecret": {
      "type": "TFY"
    },
    "status": "SUSPEND",
    "startDt": "2005-08-11T15:52:40.807Z",
    "upDt": "2002-03-07T06:28:58.898Z"
  },
  "custRec": {
    "personName": {
      "firstName": "Maude",
      "middleName": "Lettie Beck",
      "lastName": "Curtis",
      "secondLastName": "Watson"
    },
    "govIssueIdent": {
      "govIssueIdentType": "NUIP",
      "identSerialNum": "1002003001"
    },
    "personInfo": {
      "personType": "PJ"
    }
  },
  "entpr": {
    "entprDesc": "Ruby Maxwell"
  },
  "depAcctId": {
    "trnRqUid": "b3a840de-6236-58e3-9634-d59ddb2d8aee",
    "acctType": "INCLUSIVE_LOW_AMOUNT",
    "acctId" : "3445745657",
    "signInfo": {
      "value": "lu"
    },
    "bankId": "1020" ,
    "bankName" : "Bancolombia"
  }
}

Mapping Response Headers

Response Error Example:

// pendiente a validar si quedaria de esta forma
{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

- Get key (GET):

Description:

This endpoint will Consult Keys SPI.

Path:

/customers-management/v1/transfiya/entity/{iditem}/keys/{refid:

Request Data:

Uri Parameters

Headers

Success Response Example:

{
  "transaction": {
    "trnRqUid": "c4e6bd04-5149-11e7-b114-a2f933d5fe66",
    "origDt": "2017-07-21T17:32:28.000Z",
    "rquId": "acxff62e-6f12-42de-9012-1e7304418abd"
  },
  "custStatus": {
    "idItem": "d8ad8825-5cdf-5316-b791-018dee8e2c56",
    "type": "MERCHANTID",
    "value": "76.71",
    "cryptSecret": {
      "type": "guh"
    },
    "status": "SUSPEND",
    "startDt": "2005-08-11T15:52:40.807Z",
    "upDt": "2002-03-07T06:28:58.898Z"
  },
  "custRec": {
    "personName": {
      "firstName": "Maude",
      "middleName": "Lettie Beck",
      "lastName": "Curtis",
      "secondLastName": "Watson"
    },
    "govIssueIdent": {
      "govIssueIdentType": "NUIP",
      "identSerialNum": "1002003001"
    },
    "personInfo": {
      "personType": "PJ"
    }
  },
  "entpr": {
    "entprDesc": "Ruby Maxwell"
  },
  "depAcctId": {
    "trnRqUid": "b3a840de-6236-58e3-9634-d59ddb2d8aee",
    "acctType": "INCLUSIVE_LOW_AMOUNT",
    "acctId" : "3445745657",
    "signInfo": {
      "value": "lu"
    },
    "bankId": "1020" ,
    "bankName" : "Bancolombia"
  }
}

Mapping Response Headers

Response Error Example:

// pendiente a validar si quedaria de esta forma
{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

- Update key (PUT):

Description:

This endpoint for update keys SPI.

Path:

/customers-management/v1/transfiya/entity/{iditem}/keys/{refid}

Uri Parameters

Mapping Request

Request Example:

{
  "custStatus": {
    "status": "ACTIVE",
    "cryptSecret": {
      "type": "str"
    }
  },
  "depAcctId": {
    "acctType": "SAVING_ACCOUNT",
    "acctId": "6011341540651850",
    "signInfo": {
      "value": "lemwolwasa"
    }
  }
}

Headers

Mapping Response

Request Example:

{
  "responseType": {
    "value": "OK"
  },
  "transaction": {
    "trnRqUid": "c4e6bd04-5149-11e7-b114-a2f933d5fe66",
    "origDt": "2017-07-21T17:32:28.000Z",
    "rquId": "acxff62e-6f12-42de-9012-1e7304418abd"
  },
  "custStatus": {
    "idItem": "d8ad8825-5cdf-5316-b791-018dee8e2c56",
    "type": "MERCHANTID",
    "value": "76.71",
    "cryptSecret": {
      "type": "guh"
    },
    "status": "SUSPEND",
    "startDt": "2005-08-11T15:52:40.807Z",
    "upDt": "2002-03-07T06:28:58.898Z"
  },
  "custRec": {
    "personName": {
      "firstName": "Maude",
      "middleName": "Lettie Beck",
      "lastName": "Curtis",
      "secondLastName": "Watson"
    },
    "govIssueIdent": {
      "govIssueIdentType": "NUIP",
      "identSerialNum": "1002003001"
    },
    "personInfo": {
      "personType": "PJ"
    }
  },
  "entpr": {
    "entprDesc": "Ruby Maxwell"
  },
  "depAcctId": {
    "trnRqUid": "b3a840de-6236-58e3-9634-d59ddb2d8aee",
    "acctType": "INCLUSIVE_LOW_AMOUNT",
    "acctId" : "3445745657",
    "signInfo": {
      "value": "lu"
    },
    "bankId": "1020" ,
    "bankName" : "Bancolombia"
  }
}

Mapping Response Headers

- Create people (POST):

Description:

This method allows you to enroll a Bank client to act as the Payer in the Immediate Payments application.

Path:

/accounts-management/v1/customer

Headers:

Mapping Request

Example

{
  "govIssueIdent": {
    "mnemonic": "CC1012380907"
  },
  "depAcctId": {
    "acctType": "SDA",
    "acctId": "030054242",
    "bankInfo": {
      "bankId": "0032"
    }
  }
}

Mapping Request OK

Example

{
  "responseType": {
    "value": "OK"
  }
}

Mapping Response Error

Example

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

- Customer Accounts

Description:

This method allows you to get the accounts .

Path:

GET: /customers-management/v1/accounts/{mnemonic}:

Uri Parameters

Query parameters

Request Data:

Headers:

Response Body:

Mapping Response OK

Mapping Response Error

Success Response Example:

{
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "totalRecords": 8
  },
  "listAccounts": [
    {
      "depAcctId": {
        "acctType": "Ahorro",
        "acctId": "100023569871"
      },
      "product": {
        "productType": "AHORROS"
      },
      "acctBal":{
        "amt": 5733894.28
      },
      "curAmt": {
        "amt": 5733894.28
      }
    }
  ]
}

Response Error Example:

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

Diagram of sequence.

- Devices

Description:

This method allows you to update the device from which the client is accessing the App.

Path:

PUT: /customers-management/v1/devices:

Request Data:

Headers:

Request Body:

Response Body:

Mapping Response OK

Mapping Response Error

Success Response Example:

{
  "responseType": {
    "value": "OK"
  }
}

Response Error Example:

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

Diagram of sequence.

- Update Ordering Customer

Description:

This method allows the client to update an ordering account

Path:

PUT: /accounts-management/v1/customer/{mnemonic}:

Request Data:

Uri Parameters

Headers:

Canonical Request Body:

Request Example:

{
  "depAcctId": {
    "acctType": "SDA",
    "acctId": "030054242",
    "bankInfo": {
      "bankId": "0032"
    }
  }
}

Canonical Response Body:

Success Response Example:

{
    "responseType": {
        "value": "OK"
    }
}

Response Error Example:

{
    "responseType": {
        "value": "ERROSB-380000"
    },
    "responseDetail": {
        "errorCode": "OSB-380000",
        "errorDesc": "Se presenta un fallo con el servicio: -TPESVCFAIL(11):0:0:Unknown(923795923):QMNONE(0):0actualizarOrdenante_RN_TO_EBSOSB-380000actualizarOrdenante_RN_TO_EBSresponse-pipeline",
        "errorType": "EXP"
    }
}

Diagram of sequence.

- Consult payer (GET):

Description:

This method allows you to query a customer of the bank acting as originator in the immediate payment application.

Path:

GET: /accounts-management/v1/customer/{mnemonic}

Request Data:

Headers:

UriParams:

Canonical Response Body:

Request Example:

GET: /accounts-management/v1/customer/CC19444454

Success Response Example:

{
  "personInfo": {
    "mnemonic": "CC19444454",
    "fullName": "LUIS GEOVANNI HERRERO MARTINEZ",
    "cellphone": "3124712991",
    "emailAddr": "geovanniherrero@bcs.com"
   },
   "depAcctId": {
      "bankId": "0013",
      "acctType": "10",
      "acctId": "030054242"
   }
}

Response Error Example:

{
    "responseType": {
        "value": "ERR500"
    },
    "responseDetail": {
        "errorCode": "00001",
        "errorDesc": "NO ENCONTRO NINGUN REGISTRO",
        "errorType": "DAT"
    }
}

- Consult Commerce (GET):

Description:

This method allows you reviw a Bank client to act as a Merchant in the Immediate Payments application, the message specification is specified by Redeban so that it is common to multiple financial entities.

Path:

GET: /customers-management/v1/businessinfo/{orgIdNum}

Request Data:

Headers:

UriParams:

Canonical Response OK Body:

Canonical Response ERR Body:

Request Example:

GET: /customers-management/v1/businessinfo/102081

Success Response Example:

{
    "responseType": {
        "value": "OK"
    },
    "businessInfo": {
        "govIssueIdent": {
            "govIssueIdentType": "CC",
            "identSerialNum": "1007641"
        },
        "name": "rappi",
        "orgIdNum": "102081",
        "curAmt": {
            "rate": "1"
        },
        "flagPresent": null,
        "flagNotPresent": null,
        "status": {
            "statusCode": null,
            "statusDesc": null
        },
        "channel": null,
        "legalPerson": {
            "govIssueIdent": {
                "govIssueIdentType": "CC",
                "identSerialNum": "1007641"
            },
            "fullName": "juan perez"
        },
        "contactInfo": {
            "personInfo": {
                "country": "1"
            },
            "postAddr": {
                "stateProv": "1",
                "neighborhood": "1",
                "addr1": "cr 55 55 55",
                "cellphone": "3123432423",
                "phoneNum": "543534543",
                "emailAddr": "string"
            }
        },
        "resultInfo": {
            "code": "CB00000",
            "desc": "Comercio consultado correctamente en PPII."
        }
    }
}

Response Error Example:

{
    "responseType": {
        "value": "ERR500"
    },
    "responseDetail": {
        "errorCode": "00001",
        "errorDesc": "NO ENCONTRO NINGUN REGISTRO",
        "errorType": "DAT"
    }
}