bcs-management-exp

API INFORMATION

Title: bcs-management-exp

Version: 1.0.4

Protocols: HTTPS

URI Sandbox: https://bcs-management-exp-api-dev.us-e1.cloudhub.io

URI QA: https://bcs-management-exp-api-qa.us-e1.cloudhub.io

URI Live: https://bcs-management-exp-api-prod.us-e1.cloudhub.io

DOWLOAD RAML

DESCRIPTION

The API will offer consumers a connection to the APIs without having to go through a load balancer. It is currently implemented in the Remittance initiative ( Catalogs, Customer Inquiry, Payment Inquiry, Remittance Payment) and SPI( Consult Keys, Create Keys, Update Key):

Summary

- Remittances - Consult catalog.

Description:

Operation developed with the objective of making queries to the Shares and Securities database in order to obtain updated information regarding parameters whose value may change over time, understanding that for the process of sending or paying remittances, manage updated information.

Path:

GET

/utilities-management/v1/remittances/catalogue/{catalogueName}?key={key}&value={value}:

URIParams:

QueryParams:

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

• Ciudades:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Ciudades"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "cityId": "05001",
                "stateProv": "05",
                "city": "MEDELLIN",
                "flagforeign": false,
                "status": "A"
            }
        }
     ]
}

• Departamentos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Departamentos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "stateProv": "05",
                "country": "CO",
                "name": "ANTIOQUIA",
                "status": "A"
            }
        }
    ]
}

• Motivos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Motivos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "reason": "AHOINV",
                "name": "Ahorro/Inversión",
                "additionalData": {
                    "name": "Saving/Investments"
                },
                "status": "A"
            }
        }
    ]
}

• Nivel Empleo:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "NivelEmpleo"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "rank": "NIV1",
                "name": "Nivel inicial",
                "additionalData": {
                    "name": "Entry Level"
                },
                "status": "A"
            }
        }
    ]
}

• Ocupaciones:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Ocupaciones"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "jobTitle": "AGEINM",
                "required": true,
                "name": "Agente inmobiliario/de seguros/de ventas",
                "additionalData": {
                    "name": "Sales/Insurance/Real Estate ",
                    "required": true
                },
                "certCode": "9609",
                "status": "A"
            }
        }
    ]
}

• Paises:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Paises"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "country": "AD",
                "name": "Andorra",
                "additionalData": {
                    "name": "Andorra"
                },
                "countryId": "376",
                "status": "A"
            }
        }
    ]
}

• PaisMonedasDAS:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "PaisMonedaDAS"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "country": "AB",
                "curCode": "USD",
                "additionalData": {
                    "name": "US Dollar"
                },
                "flagAcceptTransferOrPayment": false,
                "flagApprovalMin": true,
                "flagApprovalDay": false,
                "active": true,
                "status": "A"
            }
        }
    ]
}

• Parentescos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Parentescos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "relationshipType": "AMG",
                "name": "Amigos",
                "additionalData": {
                    "name": "Friend"
                },
                "status": "A"
            }
        }
    ]
}

• Rangos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Rangos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "rank": "VLRACT1",
                "type": "VLRACT",
                "rankAmt": "$ 0 - $ 7,000,000.00",
                "additionalData": {
                    "rankAmt": "$ 0 - $ 7,000,000.00"
                },
                "minCurAmt": {
                    "amt": 0.00
                },
                "maxCurAmt": {
                    "amt": 7000000.00
                },
                "status": "A"
            }
        }
    ]
}

• Recursos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Recursos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "originResources": "AHORR",
                "name": "Ahorro",
                "additionalData": {
                    "name": "Savings"
                },
                "status": "A"
            }
        }
     ]
}

• Tipo de Documentos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "TipoDocumentos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "govIssueIdentType": "C.C.",
                "GovIssueIdentName": "Cédula de Ciudadanía",
                "type": "2",
                "additionalData": {
                    "type": "B"
                },
                "flagApprovalSend": true,
                "flagApprovalReceive": true,
                "flagDueDT": false,
                "govIssueIdent": {
                    "govIssueIdentType": "CC"
                },
                "status": "A"
            }
        }
   ]
}

• FormasPagos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "FormasPagos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "pmtType": "C",
                "desc": "CHEQUE",
                "flagGmf": true,
                "status": "A"
            }
        }
    ]
}

Error Code Response:

Diagrama.

- Remittances - Consult customer.

Description:

This service allows consult remittances basic data.

Path:

GET

/customers-management/v1/remittances/basic-data/{identserialnum}:

URIParams:

QUERYParams:

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

{
  "responseType":{
    "value": "OK"
  },
  "listAddress": [
    {
      "phoneNum": {
        "phone": "3105556755",
        "cellPhone": "3105556755"
      },
      "postAddr": {
        "idItem": 2,
        "cspRefId": 2,
        "addrType": "RESI",
        "addr1": "calle 30 #10-15",
        "city": "Bogota",
        "country": "Colombia",
        "postalCode": "730001",
        "cityId": "0112",
        "stateProv": "calle 30 #10-15"
      }
    }
  ],
  "beneficiary": [
    {
      "personInfo": {
        "idItem": 2,
        "cspRefId": 2,
        "identSerialNum": "1234567890",
        "emailAddr": "correo@gmail.com",
        "lastName": "DE_FRANCISCO",
        "secondLastName": "LOPEZ",
        "firstName": "CARLOS",
        "middleName": "MARIO"
      }
    }
  ],
  "senderPmtInfo": [
    {
      "cspRefId": 2,
      "type": "VLRING",
      "rank": "VLRING"
    }
  ],
  "personInfo": {
    "personName": {
      "lastName": "CAPERA",
      "secondLastName": "PAZ",
      "firstName": "DIEGO",
      "middleName": "MARIO"
    },
    "upDt": "2022-12-11",
    "clientTerminalSeqId": 0,
    "birthDt": "2022-12-11",
    "country": "CO",
    "emailAddr": "correo@gmail.com",
    "businessActivity": {
      "certCode": "086712",
      "jobTitle": "PARREG",
      "rank": "NIV1",
      "flagPubExpPerson": true,
      "branchName": ""
    },
    "cspRefId": 2,
    "gender": "F",
    "status": "Activo",
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "1234567890",
      "expCityId": "05001",
      "issDt": "2022-12-11",
      "city": "Bogota D.C",
      "country": "CO"
    }
  },
  "pmtReferences": {
    "actualizeStatus": {
      "updateRefId": "SUPGIR",
      "branchId": "SUPGIR_01"
    }
  },
  "compliance": {
    "termsConditions": true,
    "personDataProcessing": true
  }
}

Response Error Example:

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

Diagrama.

- Remittances - Consult Payments.

Description:

This service allows consult remittances basic data.

Path:

GET

/payments-management/v1/remittances/consult-payment/{refId}:

URIParams:

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

{
  "responseType": {
    "value": "OK"
  },
  "transaction": {
    "origDt": "2023-12-17T00:00:00",
    "spRefId": "7246",
    "refId": "8219535213",
    "xFerInfo": {
      "depAcctIdFrom": {
        "curtAmt": {
          "amt": 20.00,
          "curCode": "BRL"
        },
        "fullName": "SOLANGEL BALBINA VIANCHA VIANCHA",
        "country": "BR",
        "stateProv": "MT - Mato Grosso"
      },
      "depAcctIdTo": {
        "curtAmt": {
          "amt": 11097
        },
        "fullName": "NAVYA  RADHIKA"
      }
    }
  }
}

Response Error Example:

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

Diagrama.

- Remittances - Create Payments.

Description:

PagoRemesa is a service that was implemented so that a client can receive money sent by a sender who is located abroad. In order to receive the money, the client must provide personal, financial information, relationship with the sender, source of economic resources, etc. Once the service is consumed; the payment will be collected and its status in the system will change to 'Collected', that is, the payment will be collected only once.

Path:

POST

/payments-management/v1/remittances/payments:

Headers

Mapping Data:

- Request:

- Response:

Examples:

Example of Body Request:

{
    "pmtInfo": {
        "additionalData": {
            "reason": "REGALO",
            "originResources": "AHORR",
            "reationshipType": "AMG",
            "desc": "PRUEBA",
            "pmtType": "E"
        },
        "senderPmtInfo": [
            {
                "type": "VLRACT",
                "rank": "VLRACT1"
            },
            {
                "type": "VLREGR",
                "rank": "VLREGR1"
            },
            {
                "type": "VLRING",
                "rank": "VLRING3"
            },
            {
                "type": "VLRPAS",
                "rank": "VLRPAS5"
            }
        ],
        "personInfo": {
            "personName": {
                "lastName": "GONZALEZ",
                "secondLastName": "URZOLA",
                "firstName": "DANIEL",
                "middleName": "TATIANA"
            },
            "businessInfo": {
                "branchName": "BCS"
            },
            "certCode": "0010",
            "jobTitle": "EMPPLU",
            "birthDt": "1994-12-12",
            "country": "CO",
            "emailAddr": "corre@correo.com",
            "flagUpdate": true,
            "cspRefId": 0,
            "rank": "NIV1",
            "gender": "F",
            "flagPubExpPerson": false,
            "govIssueIdent": {
                "govIssueIdentType": "C.C.",
                "identSerialNum": "1234",
                "expCityId": "11001",
                "issDt": "2012-12-12",
                "city": "BOGOTA",
                "expDt": "2024-03-15",
                "country": "CO"
            }
        },
        "listAddress": [
            {
                "cellPhone": "123",
                "stateProv": "BOGOT",
                "addrType": "RESI",
                "addr1": "DIRECCION UFWPPYCVEU",
                "phone": "123",
                "city": "BOGOT",
                "postalCode": "11001",
                "cityId": "11001"
            },
            {
                "cellPhone": "123",
                "stateProv": "BOGOT",
                "addrType": "EMPR",
                "addr1": "DIRECCION UFWPPYCVEU",
                "phone": "231",
                "city": "BOGOT",
                "postalCode": "11001",
                "cityId": "11001"
            }
        ],
        "adviser": {
            "adviserId": "W9M7R1A9",
            "adviserName": "EDISON",
            "middleName": "EDISON",
            "lastName": "EDISON",
            "secondLastName": "EDISON"
        },
        "pmtReferences": {
            "createRefId": "",
            "branchId": "0106",
            "status": "A"
        },
        "refId": "123445433",
        "trnRqUID": "0"
    },
    "compliance": {
        "termsConditions": true,
        "personDataProcessing": true
    }
}

Example of Body Response:

{
    "responseType": {
        "value": "OK"
    },
    "pmtInfo": {
        "spRefId": "1111",
        "originDt": "2023-03-14 18:20:38",
        "refId": "123445433",
        "depAcctIdTo": {
            "curtAmt": {
                "amt": 8624
            }
        },
        "depAcctIdFrom": {
            "curtAmt": {
                "amt": 2
            }
        },
        "intRateInfo": {
            "amt": 4311.5385,
            "curtAmt": {
                "amt": 0.0002319
            }
        },
        "taxPmtInfo": {
            "amt": 0,
            "gmtInfo": {
                "amt": 34
            },
            "fee": {
                "amt": 0
            }
        },
        "desc": "",
        "submitOffice": {
            "branchName": "SP02",
            "branchId": "25"
        },
        "status": "US"
    }
}

Response Error Example:

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

Diagrama.

- Remittances - Consult Tirilla.

Description:

The objective of this service is to generate payment slips for the transactions carried out by the client. The slips are generated only per transaction, therefore, the service will receive the transaction ID and the MTCN as a parameter. The expected response is the strip string in base 64 format which must be converted to PDF.

Path:

GET

/documents-management/v1/remittances/payments/{trnRqUID}?refId={refId}:

URIParams:

QueryParams:

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

{
  "responseType": {
    "value": "OK"
  },
  "trnImage": {
    "binData": "JVBERi0xLjQNCiW0tba3DQolDQoxIDAgb2JqDQo8PA0KL1R5cGUgL0NhdGFsb2cNCi9QYWdlTGF5b3V0IC9PbmVDb2x1bW4NCi9QYWdlTW9kZSAvVXNlTm9uZQ0KL0Rlc3RzIDIgMCBSDQovUGFnZXMgMyAwIFINCjDQoNCmVuZG9iag0KMyAwIG9iag0KPDwNCi9UeX",
    "file": {
      "binData": "JVBERi0xLjQNCiW0tba3DQolDQoxIDAgb2JqDQo8PA0KL1ZpZXdlclByZWZlcmVuY2VzIDIgMCBSDQovUGFnZUxheW91dCAvT25lQ29sdW1uDQovVHlwZSAvQ2F0YWxvZw0KL1BhZ2VzIDMgMCBSDQovUGFnZU1vZGUgL1VzZU5vbmUNCi9EZXN0"
    }
  }
}

Diagrama.

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

Response Error Example:

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

- SPI - Consult Keys.

Description:

This endpoint allows users to get the details of a specific key using its ID.

Path:

GET

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

URIParams:

QueryParams:

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

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

Example Response Error:

{
    "responseType": {
        "value": "ER400"
    },
    "responseDetail": {
        "errorCode": "CodigoError",
        "errorDesc": "Descripcion del error",
        "errorType": "Tipo de Error"
    }
}

Diagrama.

- Customer Payment Status Report (POST):

Description:

This endpoint will use to send by an instructed agent to the upstream party in the payment chain. It is used to inform this party about the positive or negative status of an instruction (either single or file). It is also used to inform about a pending instruction.

Path:

/CustomerPaymentStatusReport:

Request Data:

Headers:

Request Example:

{
    "CstmrPmtStsRpt": {
      "GrpHdr": {
        "MsgId": "f007badf-9d05-48d0-813b-feeac6e85774",
        "CreDtTm": "2022-02-28T14:07:02"
      },
      "OrgnlGrpInfAndSts": {
        "OrgnlMsgId": "d50c92ad-47fd-4ba3-896a-6eeb8c14108f",
        "OrgnlMsgNmId": "pain001",
        "OrgnlCreDtTm": "2022-02-28T14:08:16",
        "OrgnlNbOfTxs": "1",
        "OrgnlCtrlSum": "100000.00",
        "GrpSts": "ACCP",
        "StsRsnInf": {
          "Rsn": {
            "Cd": "NT00",
            "Prtry": "Aceptado"
          },
          "AddtnlInf": "845564185167"
        }
      },
      "OrgnlPmtInfAndSts": {
        "OrgnlPmtInfId": "fbc0f86f-8c30-4efc-811d-6bbdb1133850"
      }
    }
}

Success Response Example:

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

Response Error Example:

{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "9066",
        "errorDesc": "Los datos introducidos no son correctos, favor de verificar",
        "errorType": "Bad Request"
    }
}