bcs-collections-management-api-services
home

API INFORMATION
Title: Collections-Management-Api-Services
Version: 1.0.0
Protocols: HTTPS
URI Sandbox: https://https://collections-management-api-services-dev.us-e1.cloudhub.io/collections-management/
URI QA: https://https://collections-management-api-services-qa.us-e1.cloudhub.io/collections-management/
URI Prod: https://https://collections-management-api-services-prod.us-e1.cloudhub.io/collections-management/
DOWLOAD RAML
DESCRIPTION
Collection operations
Summary
- Aggremment ICS
Path:
GET
/v1/agreement/ics:Headers
client_id: Customer identifier
client_secret: Customer key
authorization: Barear token
X-Invoker-Channel: Channel of origin of consumption
X-Invoker-AMTId: Amt code
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-CustLoginId: 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
Request information:
personInfo: Information about a person
govIssueIdent: Identification given by the local government
identSerialNum: Type of customer identification.
govIssueIdentType: Number customer IdentificationentityInformer: Reporting Entity
additionalData[0]:
name: Entity
value: Entity value
additionalData[1]:
name: Entity two
value: Entity two valueloanInfoCommon:
acctId: Customer identification number
acctType: Customer identification typetrnSrcInfo:
channel: Identification of the channel that executes the transaction
action: Action to take
status: Effect
contactStatus: Contacttransaction:
required: Review indicatorentprAgreement:
daysCycle: DurationExample of Body Request
{
"responseType": {
"value": "OK"
}
}Example of Body to Response Successfull
{
"personInfo": {
"govIssueIdent": {
"identSerialNum": "1234567890",
"govIssueIdentType": "CC"
},
"contactInfo": {
"phone": "",
"phoneAreaCode": "",
"phoneType": "",
"addres": "",
"city": "",
"zone": "",
"addrType": "",
"addr1": "",
"otherIdentDoc": {
"phoneNumAdditional": "",
"phoneAreaCode": "",
"phoneType": ""
},
"postAddr": {
"latitude": "",
"longitude": ""
}
}
},
"entityInformer": {
"additionalData": [
{
"name": "ENTIDAD",
"value": "MASIVO"
},
{
"name": "ENTIDAD2",
"value": "MASIVO"
}
]
},
"loanInfoCommon": {
"acctId": "5895180000053129617",
"acctType": "CRED CONSUMO PESOS"
},
"trnSrcInfo": {
"channel": "07",
"action": "AUTOGESTIÓN WEBCHAT",
"status": "POSIBLE PROMESA",
"contactStatus": "DEUDOR",
"desc": "Cliente confirma acuerdo de pago por el valor en mora, eligiendo la opción 2 del canal de autogestión de WEBCHAT ",
"nextPmtDt": "",
"user": ""
},
"transaction": {
"required": "N"
},
"refInfo": {
"destination": ""
},
"entprAgreement": {
"scvIdent": "",
"daysCycle": "3"
},
"pmtStatus": {
"chkNum": ""
},
"fee": {
"curAmt": {
"amt": ""
},
"establishDt": ""
}
}Errors Code.
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "00502",
"errorDesc": "CUENTA NO EXISTE.",
"errorType": "DBA"
}
}Diagrama Of Sequence.
- Negotiations.
Path:
POST
/v1/negotiations:Headers
| Name | Description | Example | Required |
|---|---|---|---|
| X-Invoker-Channel | Channel of origin of consumption | 012 | YES |
| X-Invoker-ATMId | Amt code | 1102 | NO |
| X-Invoker-BranchId | Office code | 1102 | NO |
| X-Invoker-TerminalId | Term code | NO | |
| X-Invoker-Component | Component | NO | |
| X-Invoker-UserIPAddress | Client IP Address | 10.5.43.214 | YES |
| X-Invoker-ServerIPAddress | Server IP Address | 192.168.169.197 | YES |
| X-Invoker-UserMACAddress | Client MAC Address | 0E-A5-38-F7-C3-09 | YES |
| X-Invoker-ProcessDate | Process date | 2023-05-02 | NO |
| X-Invoker-TxId | Id TX | NEGOCIACIONES | NO |
| X-Invoker-SessionKey | Session key | 112w3w*b8a-1cfe9cdd35a1 | NO |
| X-Invoker-Source | Origin | NO | |
| X-Invoker-Country | Country | CO | NO |
| X-Invoker-ProcessBpmId | ID BPM process | NO | |
| X-Invoker-ProcessId | Process ID | PRI2210323310590452 | NO |
| X-Invoker-Network | Net | 0032 | NO |
| X-Invoker-subChannel | Subchannel with which the transaction must be registered. | 04 | NO |
| X-Invoker-User | User | CC10009287 | NO |
| X-Invoker-Action | Action | NO | |
| X-Invoker-Destination | Destination | NO | |
| X-Invoker-ModifierUser | Modification | NO | |
| X-Invoker-ReferencedNumber | Reference number | NO | |
| X-Invoker-RequestNumber | Request number | 12345 | NO |
| X-Invoker-CustId | Used to identify the user who logs in | NO | |
| client_id | Customer identifier | 154-111-1111-222 | YES |
| client_secret | Customer key | 1122222-222-333 | YES |
| Authorization | Barear token | Barear 2312323 | YES |
| Accept | Accept type format | content-type | YES |
Mapping Data:
Negotiation Operation Case:
BM & SLP -- CancelacionTotal(CNTL) | PuestaAlDia(PDIA) | PlanDePagoPlazo(PPPL)
| Field Name | Description | Type | Comments |
|---|---|---|---|
| clientApp.name | Identifica el origen de la trasaccion: [Bankmaster= BM, STARLT = SLP] | String | |
| collection.strategyType | Codigo de Identificacion de la herramienta de negociacion: - Cancelacion Total = CNTL - Puesta al Dia =PDIA - Plan de Pagos= PPPL | String | |
| collection.partyAcctRelRec.acctId | Corresponde al No de Obligacion negociada para lo cual se deben completar las identificaciones de préstamos a 20 caracteres con espacios a derecha, de lo contrario el proceso no encuentra la cuenta y la rechaza como inexistente. | String | |
| collection.partyAcctRelRec.amt | Valor compromiso numérico, sin separador decimal. Sigue el estándar de valores de BM, en donde los dos últimos dígitos corresponden a valores decimales. | Number | |
| collection.partyAcctRelRec.rate | Numérico entre 1 - 100 con dos posiciones decimales. Separador decimal: punto (.))(100.00) en la mayoria de las negociaciones en porcentaje es el 100% asi no tenga valor de compromiso. | Number | |
| collection.startDt | Fecha de inicio de la marca/Fecha inicio de negociación. | Date | |
| collection.endDt | Fecha de fin de la marca. | Date | |
| collection.adviser.adviserId | Usuario de Identificacion de Colaborador Interno. | String | |
| collection.submitOffice.branchId | Código de la oficina, se debe remitir un valor fijo 9999. | Number | |
| collection.numAsignInstallments | Para los casos que aplique la modificacion del plazo se indique el plazo de manera numerica completando con ceros (0) a izquierda los 3 caracteres. | Number | |
| collection.periodGrace | Numérico 3 posiciones enteras. | Number | |
| collection.indebtedness.rate | Hace referencia al número de reestructuraciones a 2 posiciones enteras (Generico). | Number | |
| collection.partialPmt | “T” o “P”. Identifica si el compromiso es parcial o total. Cada negociación debe tener un registro de Tipo Total, y puede tener uno o varios registros de tipo Parcial. Si una negociación tiene varios compromisos, el último debe ser el de tipo total y los demás deben ser de tipo parcial. | String | . |
- Example of Body Request
{
"clientApp": {
"name": "BM"
},
"collection": {
"partyAcctRelRec": {
"acctId": "872452983283",
"amt": 1244,
"rate": 23
},
"strategyType": "PPPL",
"startDt": "2022-09-22",
"endDt": "2022-09-22",
"adviser": {
"adviserId": "User_root"
},
"submitOffice": {
"branchId": "9999"
},
"numAsignInstallments": 24,
"periodGrace": 24,
"indebtedness": {
"rate": 23
},
"partialPmt": "T"
}
}BM & SLP -- PuestaAlDiaConDiferidos(PDDA) | PlanPagosPlazoCondonacionIntermedia(PPPA)
- Mapping Body Request
| Field Name | Description | Type | Comments |
|---|---|---|---|
| clientApp.name | Identifica el origen de la trasaccion: [Bankmaster= BM, STARLT = SLP]. | String | |
| collection.strategyType | Codigo de Identificacion de la herramienta de negociacion: - Puesta al día con Diferido=PDDA - Plan de pago a plazos con Condonacion Intermedia = PPPA | String | |
| collection.partyAcctRelRec.acctId | Corresponde al No de Obligacion negociada para lo cual se deben completar las identificaciones de préstamos a 20 caracteres con espacios a derecha, de lo contrario el proceso no encuentra la cuenta y la rechaza como inexistente. | String | |
| collection.partyAcctRelRec.amt | Valor compromiso numérico, sin separador decimal. Sigue el estándar de valores de BM, en donde los dos últimos dígitos corresponden a valores decimales. | Number | |
| collection.partyAcctRelRec.rate | Numérico entre 1 - 100 con dos posiciones decimales. Separador decimal: punto (.))(100.00) en la mayoria de las negociaciones en porcentaje es el 100% asi no tenga valor de compromiso. | Number | |
| collection.startDt | Fecha de inicio de la marca/Fecha inicio de negociación. | Date | |
| collection.endDt | Fecha de fin de la marca. | Date | |
| collection.adviser.adviserId | Usuario de Identificacion de Colaborador Interno. | String | |
| collection.submitOffice.branchId | Código de la oficina, se debe remitir un valor fijo 9999. | Number | |
| collection.numAsignInstallments | Para los casos que aplique la modificacion del plazo se indique el plazo de manera numerica completando con ceros (0) a izquierda los 3 caracteres. | Number | |
| collection.periodGrace | Numérico 3 posiciones enteras. | Number | |
| collection.indebtedness.rate | Hace referencia al número de reestructuraciones a 2 posiciones enteras (Generico). | Number | |
| collection.indebtedness.numAsignInstallments | Plazo en el que se va a diferir el cargo a crear. | Number | |
| collection.partialPmt | “T” o “P”. Identifica si el compromiso es parcial o total. Cada negociación debe tener un registro de Tipo Total, y puede tener uno o varios registros de tipo Parcial. Si una negociación tiene varios compromisos, el último debe ser el de tipo total y los demás deben ser de tipo parcial. | String | . |
- Example of Body Request
{
"clientApp": {
"name": "BM"
},
"collection": {
"partyAcctRelRec": {
"acctId": "123456789",
"amt": 2343,
"rate": 23
},
"strategyType": "PDDA",
"startDt": "2022-09-22",
"endDt": "2022-09-22",
"adviser": {
"adviserId": "User_root"
},
"submitOffice": {
"branchId": "9999"
},
"numAsignInstallments": 24,
"periodGrace": 24,
"indebtedness": {
"rate": 23,
"numAsignInstallments": 24
},
"partialPmt": "T"
}
}
BM & SLP -- Preaprobados Modificaciones / Palancas Post PAD (PPPS) | Preaprobados Reestructuraciones / Palancas Post PAD (PPPS)
- Mapping Body Request
| Field Name | Description | Type | Comments |
|---|---|---|---|
| clientApp.name | Identifica el origen de la trasaccion: [Bankmaster= BM, STARLT = SLP]. | String | |
| collection.strategyType | Codigo de Identificacion de la herramienta de negociacion: - Preaprobados Modificaciones or Preaprobados Reestructuraciones = PPPS | String | |
| collection.partyAcctRelRec.acctId | Corresponde al No de Obligacion negociada para lo cual se deben completar las identificaciones de préstamos a 20 caracteres con espacios a derecha, de lo contrario el proceso no encuentra la cuenta y la rechaza como inexistente. | String | |
| collection.partyAcctRelRec.amt | Valor compromiso numérico, sin separador decimal. Sigue el estándar de valores de BM, en donde los dos últimos dígitos corresponden a valores decimales. | Number | |
| collection.partyAcctRelRec.rate | Numérico entre 1 - 100 con dos posiciones decimales. Separador decimal: punto (.))(100.00) en la mayoria de las negociaciones en porcentaje es el 100% asi no tenga valor de compromiso. | Number | |
| collection.startDt | Fecha de inicio de la marca/Fecha inicio de negociación. | Date | |
| collection.endDt | Fecha de fin de la marca. | Date | |
| collection.adviser.adviserId | Usuario de Identificacion de Colaborador Interno. | String | |
| collection.submitOffice.branchId | Código de la oficina, se debe remitir un valor fijo 9999. | Number | |
| collection.numAsignInstallments | Para los casos que aplique la modificacion del plazo se indique el plazo de manera numerica completando con ceros (0) a izquierda los 3 caracteres. | Number | |
| collection.periodGrace | Numérico 3 posiciones enteras. | Number | |
| collection.indebtedness.rate | Hace referencia al número de reestructuraciones a 2 posiciones enteras (Generico). | Number | |
| collection.partialPmt | “T” o “P”. Identifica si el compromiso es parcial o total. Cada negociación debe tener un registro de Tipo Total, y puede tener uno o varios registros de tipo Parcial. Si una negociación tiene varios compromisos, el último debe ser el de tipo total y los demás deben ser de tipo parcial. | String | |
| collection.govIssueIdent.identSerialNum | Número identificación para las tarjetas amparadas (personales y empresariales) debe venir el número de identificación del principal. | String | |
| collection.GovIssueIdent.govIssueIdentType | El campo require el tipo de docuenta: CC-Cédula Ciudadanía NI - Número Identificación Tributaria TI - Tarjeta Identidad Ce Cédula Extranjería OT- Otros | String | |
| collection.type | - R26 = Reestructuracion - MOD = Primera Modificacion - M01=Segunda Modificacion - RDO - SRO. | String | |
| collection.offer.trnRqUID | Numero de solicitud de Negociacion de credito. | String | |
| collection.offer.effDt | Numérico en formato yyyymmdd. | Date | |
| collection.intRateInfo.rate | Numérico de 2 posiciones enteras punto y seis decimales. | Number | |
| collection.intRateInfo.intRateType | Valor fijo 000. | Number | |
| collection.intRateInfo.additionalData[]_.name | Nombre del porcentaje ah registrar. Para esta herramienta solo mappea los siguientes nombres de valores: - PORCONDONAINTCTE - PORCONDONAINTMORA - PORCONDONACARGOS - PORCONDONACONTIN - PORCONDONAGAC - PORCONDONOTRCRGOS - PORCONDONCOMOP - PORCONDONSEGVID - PORCONDONSEGIRT | String | |
| collection.intRateInfo.additionalData[]_.value | Valor del porcentaje registrado. Numérico de 3 posiciones enteras punto y dos decimales. | String | . |
- Example of Body Request
{
"clientApp": {
"name": "BM"
},
"collection": {
"partyAcctRelRec": {
"acctId": "872452983283",
"amt": 12,
"rate": 23
},
"strategyType": "PPPS",
"startDt": "2022-09-22",
"endDt": "2022-09-22",
"adviser": {
"adviserId": "User_root"
},
"submitOffice": {
"branchId": "9999"
},
"numAsignInstallments": 24,
"periodGrace": 24,
"indebtedness": {
"rate": 33
},
"partialPmt": "T",
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "1234567890"
},
"type": "R26",
"offer": {
"effDt": "2022-09-22",
"trnRqUID": "28498521"
},
"intRateInfo": {
"rate": 33,
"intRateType": 123,
"additionalData": [
{
"name": "PORCONDONAINTCTE",
"value": 30.423
},
{
"name": "PORCONDONAINTMORA",
"value": 21.423
},
{
"name": "PORCONDONACARGOS ",
"value": 44.423
},
{
"name": "PORCONDONACONTIN",
"value": 11.423
},
{
"name": "PORCONDONAGAC",
"value": 88.432
},
{
"name": "PORCONDONOTRCRGOS",
"value": 30.423
},
{
"name": "PORCONDONCOMOP",
"value": 22.42
},
{
"name": "PORCONDONSEGVID",
"value": 76.4333
}, {
"name": "PORCONDONSEGIRT",
"value": 13.42222
}
]
}
}
}OTC-- TarjetaCredito(PDIA, CNTL, PPPL, REDIFERIDO)
- Mapping Body Request
| Field Name | Description | Type | Comments |
|---|---|---|---|
| clientApp.name | Identifica el origen de la trasaccion: [OPENCARD = OTC or OCR]. | String | |
| collection.strategyType | Codigo de Identificacion de la herramienta de negociacion: - Cancelacion Total = CNTL - Puesta al Dia =PDIA - Rediferidos = REDIF. | String | |
| collection.strategyId | Se debe indicar la estrategia de negociacion de acuerdo a lo establecido en el CORE: - Puesta al Dia = 01 - Rediferido = 04 - Paln de pagos = 05 - Cancelacion Total = 06 - Reestructuración Individual = 03 - Modificación Individual = 07. | String | |
| collection.partyAcctRelRec.acctId | Corresponde al No de Obligacion negociada para lo cual se deben completar las identificaciones de préstamos a 20 caracteres con espacios a derecha, de lo contrario el proceso no encuentra la cuenta y la rechaza como inexistente. | String | |
| collection.partyAcctRelRec.amt | Valor compromiso numérico, sin separador decimal. Sigue el estándar de valores de BM, en donde los dos últimos dígitos corresponden a valores decimales. | Number | |
| collection.startDt | Fecha de inicio de la marca/Fecha inicio de negociación. | Date | |
| collection.endDt | Fecha de fin de la marca. | Date | |
| collection.numAsignInstallments | Para los casos que aplique la modificacion del plazo se indique el plazo de manera numerica completando con ceros (0) a izquierda los 3 caracteres. | Number | |
| collection.govIssueIdent.identSerialNum | Número identificación para las tarjetas amparadas (personales y empresariales) debe venir el número de identificación del principal. | String | |
| collection.GovIssueIdent.govIssueIdentType | El campo require el tipo de docuenta: CC-Cédula Ciudadanía NI - Número Identificación Tributaria TI - Tarjeta Identidad Ce Cédula Extranjería OT- Otros | String | |
| collection.causalCode | Para los casos de Puesta al Dia y Rediferido se debe indicar con 4 ceros (0000) - Cancelacion Total = 303 - Plan de Pagos = 302 - Neg Reestructuración Individual = 300 - Neg Reestructuración Consolidada = 301 - Neg Modificación Consolidada = 307. | String | . |
- Example of Body Request
{
"clientApp": {
"name": "OTC"
},
"collection": {
"partyAcctRelRec": {
"acctId": "456892344",
"amt": 14
},
"strategyId": "05",
"strategyType": "CNTL",
"causalCode": "303",
"govIssueIdent": {
"identSerialNum": "1234567890",
"govIssueIdentType": "CC"
},
"startDt": "2022-09-22",
"endDt": "2022-09-22",
"numAsignInstallments": 24
}
}OCR -- CreditoRotativo (PDIA, CNTL, PPPL)
- Mapping Body Request
| Field Name | Description | Type | Comments |
|---|---|---|---|
| clientApp.name | Identifica el origen de la trasaccion: [OPENCARD = OTC or OCR]. | String | |
| collection.strategyType | Codigo de Identificacion de la herramienta de negociacion: - Cancelacion Total = CNTL - Puesta al Dia =PDIA - Plan de Pagos= PPP. | String | |
| collection.strategyId | Se debe indicar la estrategia de negociacion de acuerdo a lo establecido en el CORE: - Puesta al Dia = 01 Rediferido = 04 -Paln de pagos = 05 - Cancelacion Total = 06 - Reestructuración Individual = 03 - Modificación Individual = 07. | String | |
| collection.partyAcctRelRec.acctId | Corresponde al No de Obligacion negociada para lo cual se deben completar las identificaciones de préstamos a 20 caracteres con espacios a derecha, de lo contrario el proceso no encuentra la cuenta y la rechaza como inexistente. | String | |
| collection.partyAcctRelRec.amt | Valor compromiso numérico, sin separador decimal. Sigue el estándar de valores de BM, en donde los dos últimos dígitos corresponden a valores decimales. | Number | |
| collection.startDt | Fecha de inicio de la marca/Fecha inicio de negociación. | Date | |
| collection.endDt | Fecha de fin de la marca. | Date | |
| collection.numAsignInstallments | Para los casos que aplique la modificacion del plazo se indique el plazo de manera numerica completando con ceros (0) a izquierda los 3 caracteres. | Number | |
| collection.govIssueIdent.identSerialNum | Número identificación para las tarjetas amparadas (personales y empresariales) debe venir el número de identificación del principal. | String | |
| collection.GovIssueIdent.govIssueIdentType | El campo require el tipo de docuenta: CC-Cédula Ciudadanía NI - Número Identificación Tributaria TI - Tarjeta Identidad Ce Cédula Extranjería OT- Otros | String | |
| collection.causalCode | Para los casos de Puesta al Dia y Rediferido se debe indicar con 4 ceros (0000) - Cancelacion Total = 303 - Plan de Pagos = 302 - Neg Reestructuración Individual = 300 - Neg Reestructuración Consolidada = 301 -Neg Modificación Consolidada = 307. | String | . |
- Example of Body Request
{
"clientApp": {
"name": "OCR"
},
"collection": {
"partyAcctRelRec": {
"acctId": "456892344",
"amt": 14
},
"strategyType": "PPPL",
"strategyId": "05",
"causalCode": "302",
"govIssueIdent": {
"identSerialNum": "1234567890",
"govIssueIdentType": "CC"
},
"startDt": "2022-09-22",
"endDt": "2022-09-22",
"numAsignInstallments": 24
}
}OCR -- CreditoRotativo -- Preaprobados Reestructuraciones |Preaprobados Modificaciones (PRERM)
- Mapping Body Request
| Field Name | Description | Type | Comments |
|---|---|---|---|
| clientApp.name | Identifica el origen de la trasaccion: [OPENCARD = OTC or OCR]. | String | |
| collection.strategyType | Codigo de Identificacion de la herramienta de negociacion: - Preaprobado reestructuacion y modificacion en OpenCard=PRERM. | String | |
| collection.processDate | Numérico en formato yyyymmdd (Fecha que se remite la marca). | Date | |
| collection.govIssueIdent.identSerialNum | Número identificación para las tarjetas amparadas (personales y empresariales) debe venir el número de identificación del principal. | String | |
| collection.GovIssueIdent.govIssueIdentType | El campo require el tipo de docuenta: CC-Cédula Ciudadanía NI - Número Identificación Tributaria TI - Tarjeta Identidad Ce Cédula Extranjería OT- Otros | String | |
| collection.strategyId | Se debe indicar la estrategia de negociacion de acuerdo a lo establecido en el CORE: - Puesta al Dia = 01 Rediferido = 04 -Paln de pagos = 05 - Cancelacion Total = 06 - Reestructuración Individual = 03 - Modificación Individual = 07. | String | |
| collection.causalCode | Para los casos de Puesta al Dia y Rediferido se debe indicar con 4 ceros (0000) - Cancelacion Total = 303 - Plan de Pagos = 302 - Neg Reestructuración Individual = 300 - Neg Reestructuración Consolidada = 301 - Neg Modificación Consolidada = 307. | String | |
| collection.offer.requestNumber | Codigo Unico de Negociacion asignado desde ADMINFO. | String | |
| collection.offer.periodGrace | Un valor en numero de meses. | Number | |
| collection.offer.periodGraceDeath | Un valor en numero de meses. | Number | . |
| collection.partyAcctRelRec.acctId | Corresponde al No de Obligacion negociada para lo cual se deben completar las identificaciones de préstamos a 20 caracteres con espacios a derecha, de lo contrario el proceso no encuentra la cuenta y la rechaza como inexistente. | String | |
| collection.numAsignInstallments | Para los casos que aplique la modificacion del plazo se indique el plazo de manera numerica completando con ceros (0) a izquierda los 3 caracteres. | Number | |
| collection.quotaInfo.amt | Nuevo cupo del cliente en su tarjeta. | Number | |
| collection.intRateInfo.rate | Numérico de 2 posiciones enteras punto y seis decimales. | Number | |
| collection.intRateInfo.additionalData[]_.name | Nombre del porcentaje ah registrar. Para esta herramienta solo mappea los siguientes nombres de valores: - % A CONDONAR POR CAPITAL - % A CONDONAR POR INTERES CORRIENTE - % A CONDONAR POR INTERES DE DE MORA - % A CONDONAR POR INTERESES EXTRACONTABLES O CONTINGENTES - % A CONDONAR POR OTROS CONCEPTOS | String | |
| collection.intRateInfo.additionalData[]_.value | Valor del porcentaje registrado. Numérico de 3 posiciones enteras punto y dos decimales. | String | . |
- Example of Body Request
{
"clientApp": {
"name": "OCR"
},
"collection": {
"processDate": "2022-09-22",
"govIssueIdent": {
"identSerialNum": "1234567890",
"govIssueIdentType": "CC"
},
"strategyType": "PRERM",
"strategyId": "07",
"causalCode": "307",
"offer": {
"requestNumber": "123A",
"periodGrace": 23,
"periodGraceDeath": 111
},
"partyAcctRelRec": {
"acctId": "872452983283"
},
"numAsignInstallments": 24,
"quotaInfo": {
"amt": 12345678987654
},
"intRateInfo": {
"rate": 33,
"additionalData": [
{
"name": "% A CONDONAR POR CAPITAL",
"value": 30.4
},
{
"name": "% A CONDONAR POR INTERES CORRIENTE",
"value": 21.4
},
{
"name": "% A CONDONAR POR INTERES DE DE MORA ",
"value": 44.4
},
{
"name": "% A CONDONAR POR INTERESES EXTRACONTABLES O CONTINGENTES",
"value": 11.4
},
{
"name": "% A CONDONAR POR OTROS CONCEPTOS",
"value": 88.4
}
]
}
}
}OTC Tarjeta de Credito -- Preaprobados Reestructuraciones |Preaprobados Modificaciones (PRERM)
- Mapping Body Request
| Field Name | Description | Type | Comments |
|---|---|---|---|
| clientApp.name | Identifica el origen de la trasaccion: [OPENCARD = OTC or OCR]. | String | |
| collection.strategyType | Codigo de Identificacion de la herramienta de negociacion: - Preaprobado reestructuacion y modificacion en OpenCard=PRERM. | String | |
| collection.processDate | Numérico en formato yyyymmdd (Fecha que se remite la marca). | Date | |
| collection.govIssueIdent.identSerialNum | Número identificación para las tarjetas amparadas (personales y empresariales) debe venir el número de identificación del principal. | String | |
| collection.GovIssueIdent.govIssueIdentType | El campo require el tipo de docuenta: CC-Cédula Ciudadanía NI - Número Identificación Tributaria TI - Tarjeta Identidad Ce Cédula Extranjería OT- Otros | String | |
| collection.strategyId | Se debe indicar la estrategia de negociacion de acuerdo a lo establecido en el CORE: - Puesta al Dia = 01 Rediferido = 04 -Paln de pagos = 05 - Cancelacion Total = 06 - Reestructuración Individual = 03 - Modificación Individual = 07. | String | |
| collection.causalCode | Para los casos de Puesta al Dia y Rediferido se debe indicar con 4 ceros (0000) - Cancelacion Total = 303 - Plan de Pagos = 302 - Neg Reestructuración Individual = 300 - Neg Reestructuración Consolidada = 301 - Neg Modificación Consolidada = 307. | String | |
| collection.offer.requestNumber | Codigo Unico de Negociacion asignado desde ADMINFO. | String | |
| collection.offer.periodGrace | Un valor en numero de meses. | Number | |
| collection.offer.periodGraceDeath | Un valor en numero de meses. | Number | . |
| collection.partyAcctRelRec.acctId | Corresponde al No de Obligacion negociada para lo cual se deben completar las identificaciones de préstamos a 20 caracteres con espacios a derecha, de lo contrario el proceso no encuentra la cuenta y la rechaza como inexistente. | String | |
| collection.numAsignInstallments | Para los casos que aplique la modificacion del plazo se indique el plazo de manera numerica completando con ceros (0) a izquierda los 3 caracteres. | Number | |
| collection.quotaInfo.amt | Nuevo cupo del cliente en su tarjeta. | Number | |
| collection.intRateInfo.rate | Numérico de 2 posiciones enteras punto y seis decimales. | Number | |
| collection.intRateInfo.additionalData[]_.name | Nombre del porcentaje ah registrar. Para esta herramienta solo mappea los siguientes nombres de valores: - % A CONDONAR POR CAPITAL - % A CONDONAR POR INTERES CORRIENTE - % A CONDONAR POR INTERES DE DE MORA - % A CONDONAR POR INTERESES EXTRACONTABLES O CONTINGENTES - % A CONDONAR POR OTROS CONCEPTOS | String | |
| collection.intRateInfo.additionalData[]_.value | Valor del porcentaje registrado. Numérico de 3 posiciones enteras punto y dos decimales. | String | . |
- Example of Body Request
{
"clientApp": {
"name": "OTC"
},
"collection": {
"processDate": "2022-09-22",
"govIssueIdent": {
"identSerialNum": "1234567890",
"govIssueIdentType": "CC"
},
"strategyType": "PRERM",
"strategyId": "07",
"causalCode": "307",
"offer": {
"requestNumber": "123A",
"periodGrace": 23,
"periodGraceDeath": 111
},
"partyAcctRelRec": {
"acctId": "872452983283"
},
"numAsignInstallments": 24,
"quotaInfo": {
"amt": 12345678987654
},
"intRateInfo": {
"rate": 33,
"additionalData": [
{
"name": "% A CONDONAR POR CAPITAL",
"value": 30.4
},
{
"name": "% A CONDONAR POR INTERES CORRIENTE",
"value": 21.4
},
{
"name": "% A CONDONAR POR INTERES DE DE MORA ",
"value": 44.4
},
{
"name": "% A CONDONAR POR INTERESES EXTRACONTABLES O CONTINGENTES",
"value": 11.4
},
{
"name": "% A CONDONAR POR OTROS CONCEPTOS",
"value": 88.4
}
]
}
}
}BM & SLP & OPENCARD -- Nuevas Herramientas (Default)
- Mapping Body Request
| Field Name | Description | Type | Comments |
|---|---|---|---|
| clientApp.name | Identifica el origen de la trasaccion: [Bankmaster= BM , STARLT = SLP , OPENCARD = OTC or OCR]. | String | |
| collection.strategyType | Codigo de Identificacion de la herramienta de negociacion. | String | |
| collection.strategyId | Se debe indicar la estrategia de negociacion de acuerdo a lo establecido en el CORE. | String | |
| collection.partyAcctRelRec.acctId | Corresponde al No de Obligacion negociada para lo cual se deben completar las identificaciones de préstamos a 20 caracteres con espacios a derecha, de lo contrario el proceso no encuentra la cuenta y la rechaza como inexistente. | String | |
| collection.startDt | Fecha de inicio de la marca/Fecha inicio de negociación. | Date | |
| collection.endDt | Fecha de fin de la marca. | Date | |
| collection.adviser.adviserId | Usuario de Identificacion de Colaborador Interno. | String | |
| collection.submitOffice.branchId | Código de la oficina, se debe remitir un valor fijo 9999. | Number | |
| collection.partyAcctRelRec.amt | Valor compromiso numérico, sin separador decimal. Sigue el estándar de valores de BM, en donde los dos últimos dígitos corresponden a valores decimales. | Number | |
| collection.partyAcctRelRec.rate | Numérico entre 1 - 100 con dos posiciones decimales. Separador decimal: punto (.))(100.00) en la mayoria de las negociaciones en porcentaje es el 100% asi no tenga valor de compromiso. | Number | |
| collection.numAsignInstallments | Para los casos que aplique la modificacion del plazo se indique el plazo de manera numerica completando con ceros (0) a izquierda los 3 caracteres. | Number | |
| collection.periodGrace | Numérico 3 posiciones enteras. | Number | |
| collection.indebtedness.rate | Hace referencia al número de reestructuraciones a 2 posiciones enteras (Generico). | Number | |
| collection.indebtedness.numAsignInstallments | Plazo en el que se va a diferir el cargo a crear. | Number | |
| collection.partialPmt | “T” o “P”. Identifica si el compromiso es parcial o total. Cada negociación debe tener un registro de Tipo Total, y puede tener uno o varios registros de tipo Parcial. Si una negociación tiene varios compromisos, el último debe ser el de tipo total y los demás deben ser de tipo parcial. | String | |
| collection.govIssueIdent.identSerialNum | Número identificación para las tarjetas amparadas (personales y empresariales) debe venir el número de identificación del principal. | String | |
| collection.GovIssueIdent.govIssueIdentType | El campo require el tipo de docuenta: CC-Cédula Ciudadanía NI - Número Identificación Tributaria TI - Tarjeta Identidad Ce Cédula Extranjería OT- Otros | String | |
| collection.causalCode | Determinar el codifo causal. | String | |
| collection.orgInfo.govIssueIdent.IdentSerialNum | Numero de identificación del primer titular principal. Justificado a la derecha y lleno de ceros ala izquierda. | Number | |
| collection.type | Tipo de modificacion o restructuracion. | String | |
| collection.offer.trnRqUID | Numero de solicitud de Negociacion de credito. | String | |
| collection.offer.requestNumber | Codigo Unico de Negociacion asignado desde ADMINFO. | String | |
| collection.offer.effDt | Numérico en formato yyyymmdd. | Date | |
| collection.createdDt | Fecha de creacion 230213. | Date | |
| collection.intRateInfo.rate | Numérico de 2 posiciones enteras punto y seis decimales. | Number | |
| collection.intRateInfo.amt | Valor de la tasa ajustar 4 caracteres "4224". | Number | |
| collection.intRateInfo.intRateType | Valor fijo 000. | Number | |
| collection.processDate | Numérico en formato yyyymmdd (Fecha que se remite la marca). | Date | |
| collection.intRateInfo.additionalData[]_.name | Nombre del porcentaje ah registrar. | String | |
| collection.intRateInfo.additionalData[]_.value | Valor del porcentaje registrado. Numérico de 3 posiciones enteras punto y dos decimales. | String | |
| collection.quotaInfo.amt | Nuevo cupo del cliente en su tarjeta. | Number | |
| collection.offer.periodGrace | Un valor en numero de meses. | Number | |
| collection.offer.periodGraceDeath | Un valor en numero de meses. | Number | . |
- Example of Body Request
{
"clientApp": {
"name": "BM || SLP || OTC || OCR"
},
"collection": {
"partialPmt": "T",
"intRateInfo": {
"additionalData": [
{
"name": "Nombre porcentaje",
"value": 99.445
}
],
"amt": 1432,
"curRate": 2,
"rate": 99.445,
"intRateType": "F"
},
"createdDt": "2022-09-22",
"periodGrace": 24,
"processDate": "2022-09-22",
"offer": {
"periodGrace": 23,
"effDt": "2022-09-22",
"collateralType": "20",
"periodGraceDeath": 111,
"requestNumber": "123A",
"trnRqUID": "28498521"
},
"adviser": {
"adviserId": "User_root"
},
"strategyType": "PDIA",
"partyAcctRelRec": {
"acctId": "12345678901234567890",
"amt": 1234,
"rate": 33,
"acctType": "Credit..."
},
"numAsignInstallments": 24,
"strategyId": "03",
"submitOffice": {
"branchId": "9999"
},
"type": "R26",
"causalCode": "302",
"endDt": "2022-09-22",
"indebtedness": {
"rate": 33,
"numAsignInstallments": 24
},
"govIssueIdent": {
"identSerialNum": "1234567890",
"govIssueIdentType": "CC"
},
"startDt": "2022-09-22",
"quotaInfo": {
"amt": 213
},
"invoicePmtInfo": {
"daysCycle": 24
}
}
}> Respuesta para todos los servicios de negociacion
- Mapping Body Response
| Field Name | Description | Type | Comments |
|---|---|---|---|
| collection.partyAcctRelRec.acctId | Numero de producto | String | |
| collection.state | Estado del Registro de la Marcacion de la negociacion en Core Bancario. | String | |
| collection.createdDt | Numérico en formato yyyymmdd (Fecha que se remite la marca) | Date | |
| collection.desc | Detalla el Motivo de Rechazo de la Marcacion de la Negociacion en el Core Bancario. | String | . |
- Example of Body Response
{
"collection": {
"partyAcctRelRec": {
"acctId": "456892344"
},
"state": "Received",
"createdDt": "2023-05-10",
"desc": "successful transaction"
}
}Diagrama Of Sequence.

- Profiling - Decision Motor.
Path:
POST
/v1/negotiations/profile:Headers
| Name | Description | Example |
|---|---|---|
| X-Invoker-Channel | Channel of origin of consumption | 007 |
| X-Invoker-ATMId | Amt code | 1102 |
| X-Invoker-BranchId | Office code | 1102 |
| X-Invoker-TerminalId | Term code | |
| X-Invoker-Component | Component | |
| X-Invoker-UserIPAddress | Client IP Address | 10.5.43.214 |
| X-Invoker-ServerIPAddress | Server IP Address | 192.168.169.197 |
| X-Invoker-UserMACAddress | Client MAC Address | 0E-A5-38-F7-C3-09 |
| X-Invoker-ProcessDate | Process date | 2023-05-02 |
| X-Invoker-TxId | Id TX | |
| X-Invoker-SessionKey | Session key | 112w3w*b8a-1cfe9cdd35a1 |
| X-Invoker-Source | Origin | |
| X-Invoker-Country | Country | CO |
| X-Invoker-ProcessBpmId | ID BPM process | |
| X-Invoker-ProcessId | Process ID | PRI2210323310590452 |
| X-Invoker-Network | Net | 0032 |
| X-Invoker-subChannel | Subchannel with which the transaction must be registered. | 01 |
| X-Invoker-User | User | CC10009287 |
| X-Invoker-Action | Action | |
| X-Invoker-Destination | Destination | |
| X-Invoker-ModifierUser | Modification | |
| X-Invoker-ReferencedNumber | Reference number | |
| X-Invoker-RequestNumber | Request number | 12345 |
| X-Invoker-CustId | Used to identify the user who logs in | |
| client_id | Customer identifier | 154-111-1111-222 |
| client_secret | Customer key | 1122222-222-333 |
| Authorization | Barear token | Barear 2312323 |
| Accept | Accept type format | content-type |
Mapping Data:
- Request:
| Field Name | Description | Type |
|---|---|---|
| listValidation[]*.transaccion.trnRqUID | Number that identifies the client's request. | String |
| listValidation[]*.govIssueIdent.govIssueIdentType | Customer identification type: [CC, NI, CE, NE]. | String |
| listValidation[]*.govIssueIdent.identSerialNum | Client Identification Number. | String |
| listValidation[]*.naturalPerson.personName.lastName | Client's First Last Name. | String |
| listValidation[]*.naturalPerson.age | Client Age. | Number |
| listValidation[]*.naturalPerson.city | City where the loan is located. | String |
| listValidation[]*.naturalPerson.maritalStatusInfo.maritalStatus | Values 01-05. 01: SOLTERO/A, 02: CASADO/A O UNION LIBRE, 03: SEPARADO/A O DIVORCIADO/A, 04: VIUDO/A. | String |
| listValidation[]*.naturalPerson.semiPrivatePersonInfo.educationLevel | Values 01-05 and 99. | String |
| listValidation[]*.transaccion.operationType | Transaccion Type: A - Automatic M–Manual | String |
| listValidation[]*.partyAcctRelRec.acctId | Obligation number. | Number |
| listValidation[]*.collection.flagSelected | Can you pay your current and future installment? "false" or "true" | Boolean |
| listValidation[]*.collection.suggestedPmtAmt | Installment amount you can pay?. | Number |
| listValidation[]*.collection.delinqAging.amt | How much do you have available to pay the late payment?. | Number |
| listValidation[]*.collection.delinqAging.flagPreventPayment | To date, have you overcome the situation that prevents you from making payments? "true" or "false". | Boolean |
| listValidation[]*.collection.delinqAging.reason | Reason for non-payment of the Client. | String |
| listValidation[]*.compliance.personDataProcessing | Data Processing Authorization (True or False). | Boolean |
| listValidation[]*.naturalPerson.businessOcucupation[].job | Name of the occupation. | String |
| listValidation[]*.naturalPerson.businessOcucupation[].type | type of the occupation ("Principal" or "Secondary"). | String |
| listValidation[]*.businessInfo.labourContractType | For Employee: Temporal - Indefinido - Prestación de Servicios - Obra labor. | String |
| listValidation[]*.businessInfo.labourSector | Economic sector in which the client develops his occupation (Privada - Público- Mixto). | String |
| listValidation[]*.businessProfessionGeneral.businessType | Type of economic activity in which it develops ("actividadGeneral"). | String |
| listValidation[]*.businessProfessionGeneral.desc | Economic activity in which it is developed. | String |
| listValidation[]*.businessProfessionSpecific.businessType | Type of economic activity in which it develops ("actividadEspecifica"). | String |
| listValidation[]*.businessProfessionSpecific.desc | Specific economic activity in which its activity is developed. | String |
| listValidation[]*.businessInfo.jobYears | Time in which you are developing your economic activity. | Number |
| listValidation[]*.personInfo.incomeInfo.incomeAmt | Gross monthly income obtained by the client as a result of his economic activity. | Number |
| listValidation[]*.personInfo.otherIncome.amt | Other additional income that the client receives or financial aid. | Number |
| listValidation[]*.personInfo.financialLiabilities.amt | Personal and family expenses and debts. | Number |
| listValidation[]*.businessPerson.financialAssets.amt | Sales value you get with Independent occupation or PJ. | Number |
| listValidation[]*.businessPerson.expenses.amt | Costs of the operation - Independent or PJ (legal entity). | Number |
| listValidation[]*.personInfo.curAmt.amt | Calculation: Monthly Sales - Operating Costs, net income. | Number |
| listValidation[]*.collection.totalCurAmt.amt | Calculation: Salary / Pension / Rent + Business Unit Net Profit + Other Income - Total family and personal expenses. | Number |
| listValidation[]*.naturalPerson.govRank | range code the FFMM: Civil Officer, NCO, Capethird, Airman Petty Officer, SailorSecond, soldiers. | String |
| listValidation[]*.personInfo.role | Refers to the requester's role type: ["01" = "Principal", "02" = "Secundario"]. | String |
| listValidation[]*.personInfo.incomeInfo.flagContributor | flag contributes income: [True = "Si", False = "No"]. | Boolean |
| listValidation[]*.offer.processStage | It is the stage of the process in which the service is executed:["02": Generación de la oferta, "04": Análisis]. | String |
| listValidation[]*.offer.indMoment | It is the time when the process is executed:["01": Primer momento, "02": Segundo momento]. | String |
| listValidation[]*.offer.executionLine | The line of execution of the types of products:["U"=UPNF, "V"=Vivienda, "C"=Consumo]. | String |
- Response:
| Field Name | Description | Type |
|---|---|---|
| listValidation[]*.transaccion.action | Description of the action that has been executed: ["Query SOIDATA", "Query CIFIN_ING", "Check CREDIT DATA", "PROFILING calculation"]. | String |
| listValidation[]*.transaccion.trnRqUID | Number that identifies the client's request. | String |
| listValidation[]*.govIssueIdent.govIssueIdentType | Customer identification type: [CC, NI, CE, NE]. | String |
| listValidation[]*.govIssueIdent.identSerialNum | Client Identification Number. | String |
| listValidation[]*.partyAcctRelRec.acctId | Obligation number. | Number |
| responseDeatil.responseType.value | Result of the transaction ["OK", "ER"] | String |
| responseDeatil.errorCode | Code that is generated to display an error (Mandatory in case of error). | String |
| responseDeatil.errorDesc | Detailed description of the error (Mandatory in case of error). | String |
| responseDeatil.errorType | Type of the error that is generated (Mandatory in case of error). | String |
Examples:
Example of Body Request:
{
"listValidation": [
{
"transaccion": {
"trnRqUID": "28498521",
"operationType": "A"
},
"partyAcctRelRec": {
"acctId": "12345678901234567890"
},
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "1234567890"
},
"compliance": {
"personDataProcessing": true
},
"naturalPerson": {
"personName": {
"lastName": "DE_FRANCISCO"
},
"age": 30,
"city": "DANE",
"maritalStatusInfo": {
"maritalStatus": "S"
},
"semiPrivatePersonInfo": {
"educationLevel": "01"
},
"govRank": "Suboficial",
"businessOccupation": [
{
"job": "Empleado",
"type": "Primary"
}
]
},
"businessInfo": {
"labourContractType": "Indefinido",
"labourSector": "Privada",
"jobYears": 8
},
"collection": {
"flagSelected": true,
"suggestedPmtAmt": 1441551,
"delinqAging": {
"amt": 134533,
"flagPreventPayment": true,
"reason": "The customer said..."
},
"totalCurAmt": 1441551
},
"personInfo": {
"incomeInfo": {
"incomeAmt": 25000000,
"flagContributor": true
},
"otherIncome": {
"amt": 134533
},
"financialLiabilities": {
"amt": 134533
},
"financialAssets": {
"amt": 134533
},
"expenses": {
"amt": 134533
},
"curAmt": {
"amt": 134533
},
"totalCurAmt": {
"amt": 134533
},
"role": "01"
},
"businessProfessionGeneral": {
"businessType": "actividadGeneral",
"desc": "actividadGeneral- desc"
},
"businessProfessionSpecific": {
"businessType": "actividadEspecifica",
"desc": "actividadEspecifica-desc"
},
"offer": {
"processStage": "02",
"indMoment": "01",
"executionLine": "V"
}
}
]
}Example of Body Response:
{
"listValidation": [
{
"transaccion": {
"action": "Calculo PERFILAMIENTO",
"trnRqUID": "28498521"
},
"partyAcctRelRec": {
"acctId": "12345678901234567890"
},
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "1234567890"
}
}
],
"responseType": {
"value": "OK"
}
}Error Code Response:
| HTTPCode | ErrorCode | ErrorType | Description |
|---|---|---|---|
| TBD | 10001 | OTR | "Error al ejecutar el PL": Cuando se presenta un error en la invocación del PL. |
| TBD | 10002 | OTR | "El objeto de Entrada es nulo": Cuando se presenta un error en la invocación del PL. |
| TBD | 10007 | OTR | "Error al transformar": Cuando en una de las transformaciones se presenta un error. |
| TBD | 10101 | OTR | "Error en la Consulta del Buro": Cuando se presenta un error al consumir los servicios de CIFIN / Datacredito. |
| TBD | 15001 | OTR | "Error en inesperado en el procesamiento del servicio": Cuando se presenta un error no controlado en la aplicación. |
Diagrama.

- AppPolicie- Decision Motor.
Path:
POST
/v1/negotiations/policies:Description:
Web service that analyzes the viability of clients who have one or more products with the bank. AppPoliticas keeps track of history, behavior, obligations and others key factors, obtaining information from multiple sources, including INCOME, PROFINING and data of the CAMPAIGNS. However, its focus is specifically on clients with existing relationships with the bank, either to negotiate outstanding debts or to explore additional opportunities.
Headers
| Name | Description | Example |
|---|---|---|
| X-Invoker-Channel | Channel of origin of consumption | 007 |
| X-Invoker-ATMId | Amt code | 1102 |
| X-Invoker-BranchId | Office code | 1102 |
| X-Invoker-TerminalId | Term code | |
| X-Invoker-Component | Component | |
| X-Invoker-UserIPAddress | Client IP Address | 10.5.43.214 |
| X-Invoker-ServerIPAddress | Server IP Address | 192.168.169.197 |
| X-Invoker-UserMACAddress | Client MAC Address | 0E-A5-38-F7-C3-09 |
| X-Invoker-ProcessDate | Process date | 2023-05-02 |
| X-Invoker-TxId | Id TX | |
| X-Invoker-SessionKey | Session key | 112w3w*b8a-1cfe9cdd35a1 |
| X-Invoker-Source | Origin | |
| X-Invoker-Country | Country | CO |
| X-Invoker-ProcessBpmId | ID BPM process | |
| X-Invoker-ProcessId | Process ID | PRI2210323310590452 |
| X-Invoker-Network | Net | 0032 |
| X-Invoker-subChannel | Subchannel with which the transaction must be registered. | 01 |
| X-Invoker-User | User | CC10009287 |
| X-Invoker-Action | Action | |
| X-Invoker-Destination | Destination | |
| X-Invoker-ModifierUser | Modification | |
| X-Invoker-ReferencedNumber | Reference number | |
| X-Invoker-RequestNumber | Request number | 12345 |
| X-Invoker-CustId | Used to identify the user who logs in | |
| client_id | Customer identifier | 154-111-1111-222 |
| client_secret | Customer key | 1122222-222-333 |
| Authorization | Barear token | Barear 2312323 |
| Accept | Accept type format | content-type |
Mapping Data:
- Request:
| Field Name | Description | Type |
|---|---|---|
| creditAnalysis[]*.collection.transaction.trnRqUID | Id transaction. | String |
| creditAnalysis[]*.collection.strategyType | Type of negotiation to apply | String |
| creditAnalysis[]*.collection.govIssueIdent.govIssueIdentType | Customer identification type: [CC, NI, CE, NE]. | String |
| creditAnalysis[]*.collection.govIssueIdent.identSerialNum | Client Identification Number. | String |
| creditAnalysis[]*.collection.partyAcctRelRec.acctId | Obligation number. | String |
| creditAnalysis[]*.collection.partyAcctRelRec.amt | Payment value. | Number |
| creditAnalysis[]*.collection.pmtStatus.flagRecalculate | Variable mark if recalculation is required or not "false" or "true" | Boolean |
| creditAnalysis[]*.collection.curAmt.amt | Quota value | Number |
| creditAnalysis[].collection.intRateInfo.curAmt[].desc | Name of the percentages to be registered, only the following will be accepted: ["CAPITAL","INTERESES_CORRIENTES","INTERESES_MORA","SEGUROS","CARGOS_CE07","CARGOS_CE014","CARGOS_CE022","CARGOS_CE016","CARGOS_CPA","CARGOS_SIP","COMISION_BANCOLDEX","COMISION_FINAGRO","COMISION_FNG","COMISION_MIPYME","COMISION_USAID","GAC","INTERES_ANTICIPADOS","INTERES_CORTE","INTERES_MORA"] | String |
| creditAnalysis[].collection.intRateInfo.curAmt[].rate | Percentage value. | Number |
| creditAnalysis[].collection.intRateInfo.curAmt[].amt | Amount of percentage. | Number |
| creditAnalysis[]*.collection.indebtedness.establishDt | Date Agreed period of the negotiation. | String |
| creditAnalysis[]*.collection.indebtedness.numAsignInstallments | New Term. | Number |
| creditAnalysis[]*.collection.indebtedness.periodGrace | Grace period. | Number |
| creditAnalysis[]*.collection.indebtedness.rate | New Interest Rate. | Number |
| creditAnalysis[]*.collection.indebtedness.amt | Value of the deferred charge per installment. | Number |
| creditAnalysis[]*.collection.indebtedness.numberOfInstallments | Negotiation period. | Number |
| creditAnalysis[]*.collection.indebtedness.totalPmtCount | Total re-deferral period. | Number |
| creditAnalysis[]*.collection.indebtedness.term | Deferred charge period. | Number |
| creditAnalysis[]*.collection.validity.startDt | Effective Date of the negotiation (YYYY-MM-DD). | String - Date |
| creditAnalysis[]*.collection.validity.openDt | Start date of negotiation for payment (YYYY-MM-DD). | String - Date |
| creditAnalysis[]*.collection.validity.endDt | Finish date of negotiation for payment (YYYY-MM-DD). | String - Date |
| creditAnalysis[]*.collection.causalNoViabilitynInfo[].descriptionDesc. | Names of Causes of non-viability tool. Only the following values will be accepted: ["causalDeNoViabilidadHerremienta1", "causalDeNoViabilidadPuestaAlDia2", "causalDeNoViabilidadPuestaAlDia3", "causalDeNoViabilidadPuestaAlDia4", "causalDeNoViabilidadPuestaAlDia5", "causalDeNoViabilidadPuestaAlDia6", "causalDeNoViabilidadPuestaAlDia7"]. | String |
| creditAnalysis[]*.collection.causalNoViabilitynInfo[].viabilityResult | Result of tool viability. | String |
| creditAnalysis[]*.collection.offer.flagViability | Tool Feasibility (Viable or not) "false" or "true". | String |
| creditAnalysis[]*.collection.offer.viabilityLevel | Number and level of attribution. | Number |
| creditAnalysis[]*.collection.offer.count | Number of viable offers per obligation. | Number |
| creditAnalysis[]*.collection.discount.amt | Sum of Forgiven Values. | Number |
| creditAnalysis[]*.collection.partyAcctRelRec.bankAcctStatusCode | Credit status of the field (Active/Inactive) | String |
| creditAnalysis[]*.collection.delinqAging.daysCount | Days past due. | Number |
| creditAnalysis[]*.collection.extAcctBal.amt | Commission value. | Number |
| creditAnalysis[]*.collection.acctBal.amt | Capital balance. | Number |
| creditAnalysis[]*.collection.intRateInfo.amt | Interest balance. | Number |
| creditAnalysis[]*.collection.fee.amt | Calculated field of the administrative collection expenses that must be charged to the client. | Number |
| creditAnalysis[].collection.insuranceInfo[].policyName | Insurance name, only the following will be accepted: ["SEGURO_TERREMOTO", "SEGURO_DESEMPLEO", "SEGURO_INCENDIO", "SEGURO_RAYO", "SEGURO_VENCIDO_RAYO","SEGURO_VENCIDO_INCENDIO","SEGURO_VENCIDO_TERREMOTO","SEGURO_VIDA_CTA_COBRO"] | String |
| creditAnalysis[].collection.insuranceInfo[].amt | Amount of policy. | Number |
| creditAnalysis[]*.collection.collateralDesc | Amortization system. | String |
| creditAnalysis[]*.collection.intRateInfo.rate | Interest rate. | Number |
| creditAnalysis[]*.collection.dueDt | Billing date. | String-Date |
| creditAnalysis[]*.collection.extAcctBal.curAmt.amt | Other payments. | Number |
| creditAnalysis[]*.collection.collateral.code | Warranty code. | String |
| creditAnalysis[]*.collection.capitalizationAcctId.code | Ownership code. | String |
| creditAnalysis[].collection.fee.curAmt[].desc | Name of Commission, Only the following values will be accepted: ["COMISION_MIPYME","COMISION_FNG","COMISION_USAID","COMISION_BANCOLDEX","COMISION_FINAGRO"] | String |
| creditAnalysis[].collection.fee.curAmt[].amt | Amount of Commission. | Number |
| creditAnalysis[].collection.extraordinaryFee[].desc | Name of Extra-Commission, Only the following values will be accepted: ["CARGOS_SIP","CARGOS_CPA","CARGO_C22","VAL_OTROS_CARGOS_LEASI","VALOR_CARGOXCUOTA","CARGOSDIFERIDOS_PDD"] | String |
| creditAnalysis[]*.collection.partyAcctRelRec.additionalAccountId | Subproduct. | String |
| creditAnalysis[]*.collection.offer.amt | New interest rate. | Number |
| creditAnalysis[].collection.causalExceptionInfo[].name | Exception name, only the following values will be accepted: ["EXC_CUOTAS_PAGAS_APLICADAS","EXC_DIAS_MORA","EXC_FECHA_EXPEDICION","EXC_CUOTAS_PAGAS","EXC_NUMERO_HERRAMIENTAS","EXC_PLAZO_NEGOCIACION","EXC_PERIODO_VIGILANCIA_INCUMPLIDA","EXC_PERIODO_VIGILANCIA","EXC_CARGO_DIFERIDO","EXC__TIEMPO_ENTRE_HERR"] | String |
| creditAnalysis[].collection.causalExceptionInfo[].value | Amount of exception. | Number |
| creditAnalysis[]*.collection.AdditionalData[].name | Name variable additionalData. Only the following values will be accepted: ["FLAG_VALOR_PAGO","FLAG_VALOR_NUEVA_CUOTA","FLAG_NUEVO_PLAZO","FLAG_PERIODO_GRACIA","FLAG_NUEVA_TASA","FLAG_SALDO_CONSOLIDADO","FLAG_PLAZO_NEGOCIACION"] | String |
| creditAnalysis[]*.collection.AdditionalData[].value | Value variable additionalData. | String |
| creditAnalysis[]*.collection.partyAcctRelRec.additionalAcctId | concatenation of obligations. | String |
| creditAnalysis[]*.collection.partyAcctRelRec.flagSelectedOffered | variable mark if the credit is up to date, delinquent or due. Examples: [FDTA, FDTM, FDTP] | String |
| creditAnalysis[]*.collection.extendedDiscount.flagFindeter | Check if the credit has a Findeter benefit or not. | String |
| creditAnalysis[]*.collection.extendedDiscount.flagWalletFindeter | Mark whether or not the credit has a benefit, notifying in response the type of discount applied. | String |
- Response:
| Field Name | Description | Type |
|---|---|---|
| responseDeatil.responseType.value | Result of the transaction ["OK", "ER"] | String |
| responseDeatil.errorCode | Code that is generated to display an error (Mandatory in case of error). | String |
| responseDeatil.errorDesc | Detailed description of the error (Mandatory in case of error). | String |
| responseDeatil.errorType | Type of the error that is generated (Mandatory in case of error). | String |
| creditAnalysis[]*.collection.transaction.trnRqUID | Id transaction. | String |
| creditAnalysis[]*.collection.strategyType | Type of negotiation to apply | String |
| creditAnalysis[]*.collection.govIssueIdent.govIssueIdentType | Customer identification type: [CC, NI, CE, NE]. | String |
| creditAnalysis[]*.collection.govIssueIdent.identSerialNum | Client Identification Number. | String |
| creditAnalysis[]*.collection.partyAcctRelRec.acctId | Obligation number. | String |
| creditAnalysis[]*.collection.partyAcctRelRec.amt | Payment value. | Number |
| creditAnalysis[]*.collection.pmtStatus.flagRecalculate | Variable mark if recalculation is required or not "false" or "true" | Boolean |
| creditAnalysis[]*.collection.curAmt.amt | Quota value | Number |
| creditAnalysis[].collection.intRateInfo.curAmt[].desc | Name of the percentages to be registered, only the following will be accepted: ["CAPITAL","INTERESES_CORRIENTES","INTERESES_MORA","SEGUROS","CARGOS_CE07","CARGOS_CE014","CARGOS_CE022","CARGOS_CE016","CARGOS_CPA","CARGOS_SIP","COMISION_BANCOLDEX","COMISION_FINAGRO","COMISION_FNG","COMISION_MIPYME","COMISION_USAID","GAC","INTERES_ANTICIPADOS","INTERES_CORTE","INTERES_MORA"] | String |
| creditAnalysis[].collection.intRateInfo.curAmt[].rate | Percentage value. | Number |
| creditAnalysis[].collection.intRateInfo.curAmt[].amt | Amount of percentage. | Number |
| creditAnalysis[]*.collection.indebtedness.establishDt | Date Agreed period of the negotiation. | String |
| creditAnalysis[]*.collection.indebtedness.numAsignInstallments | New Term. | Number |
| creditAnalysis[]*.collection.indebtedness.periodGrace | Grace period. | Number |
| creditAnalysis[]*.collection.indebtedness.rate | New Interest Rate. | Number |
| creditAnalysis[]*.collection.indebtedness.amt | Value of the deferred charge per installment. | Number |
| creditAnalysis[]*.collection.indebtedness.numberOfInstallments | Negotiation period. | Number |
| creditAnalysis[]*.collection.indebtedness.totalPmtCount | Total re-deferral period. | Number |
| creditAnalysis[]*.collection.indebtedness.term | Deferred charge period. | Number |
| creditAnalysis[]*.collection.validity.startDt | Effective Date of the negotiation (YYYY-MM-DD). | String - Date |
| creditAnalysis[]*.collection.validity.openDt | Start date of negotiation for payment (YYYY-MM-DD). | String - Date |
| creditAnalysis[]*.collection.validity.endDt | Finish date of negotiation for payment (YYYY-MM-DD). | String - Date |
| creditAnalysis[]*.collection.causalNoViabilitynInfo[].descriptionDesc. | Names of Causes of non-viability tool. Only the following values will be accepted: ["causalDeNoViabilidadHerremienta1", "causalDeNoViabilidadPuestaAlDia2", "causalDeNoViabilidadPuestaAlDia3", "causalDeNoViabilidadPuestaAlDia4", "causalDeNoViabilidadPuestaAlDia5", "causalDeNoViabilidadPuestaAlDia6", "causalDeNoViabilidadPuestaAlDia7"]. | String |
| creditAnalysis[]*.collection.causalNoViabilitynInfo[].viabilityResult | Result of tool viability. | String |
| creditAnalysis[]*.collection.offer.flagViability | Tool Feasibility (Viable or not). | String |
| creditAnalysis[]*.collection.offer.viabilityLevel | Number and level of attribution. | Number |
| creditAnalysis[]*.collection.offer.count | Number of viable offers per obligation. | Number |
| creditAnalysis[]*.collection.discount.amt | Sum of Forgiven Values. | Number |
| creditAnalysis[]*.collection.partyAcctRelRec.bankAcctStatusCode | Credit status of the field (Active/Inactive) | String |
| creditAnalysis[]*.collection.delinqAging.daysCount | Days past due. | Number |
| creditAnalysis[]*.collection.extAcctBal.amt | Commission value. | Number |
| creditAnalysis[]*.collection.acctBal.amt | Capital balance. | Number |
| creditAnalysis[]*.collection.intRateInfo.amt | Interest balance. | Number |
| creditAnalysis[]*.collection.fee.amt | Calculated field of the administrative collection expenses that must be charged to the client. | Number |
| creditAnalysis[].collection.insuranceInfo[].policyName | Insurance name, only the following will be accepted: ["SEGURO_TERREMOTO", "SEGURO_DESEMPLEO", "SEGURO_INCENDIO", "SEGURO_RAYO", "SEGURO_VENCIDO_RAYO","SEGURO_VENCIDO_INCENDIO","SEGURO_VENCIDO_TERREMOTO","SEGURO_VIDA_CTA_COBRO"] | String |
| creditAnalysis[].collection.insuranceInfo[].amt | Amount of policy. | Number |
| creditAnalysis[]*.collection.collateralDesc | Amortization system. | String |
| creditAnalysis[]*.collection.intRateInfo.rate | Interest rate. | Number |
| creditAnalysis[]*.collection.dueDt | Billing date. | String-Date |
| creditAnalysis[]*.collection.extAcctBal.curAmt.amt | Other payments. | Number |
| creditAnalysis[]*.collection.collateral.code | Warranty code. | String |
| creditAnalysis[]*.collection.capitalizationAcctId.code | Ownership code. | String |
| creditAnalysis[].collection.fee.curAmt[].desc | Name of Commission, Only the following values will be accepted: ["COMISION_MIPYME","COMISION_FNG","COMISION_USAID","COMISION_BANCOLDEX","COMISION_FINAGRO"] | String |
| creditAnalysis[].collection.fee.curAmt[].amt | Amount of Commission. | Number |
| creditAnalysis[].collection.extraordinaryFee[].desc | Name of Extra-Commission, Only the following values will be accepted: ["CARGOS_SIP","CARGOS_CPA","CARGO_C22","VAL_OTROS_CARGOS_LEASI","VALOR_CARGOXCUOTA","CARGOSDIFERIDOS_PDD"] | String |
| creditAnalysis[]*.collection.partyAcctRelRec.additionalAccountId | Subproduct. | String |
| creditAnalysis[]*.collection.offer.amt | New interest rate. | Number |
| creditAnalysis[].collection.causalExceptionInfo[].name | Exception name, only the following values will be accepted: ["EXC_CUOTAS_PAGAS_APLICADAS","EXC_DIAS_MORA","EXC_FECHA_EXPEDICION","EXC_CUOTAS_PAGAS","EXC_NUMERO_HERRAMIENTAS","EXC_PLAZO_NEGOCIACION","EXC_PERIODO_VIGILANCIA_INCUMPLIDA","EXC_PERIODO_VIGILANCIA","EXC_CARGO_DIFERIDO","EXC__TIEMPO_ENTRE_HERR"] | String |
| creditAnalysis[].collection.causalExceptionInfo[].value | Amount of exception. | Number |
| creditAnalysis[]*.collection.AdditionalData[].name | Name variable additionalData. Only the following values will be accepted: ["FLAG_VALOR_PAGO","FLAG_VALOR_NUEVA_CUOTA","FLAG_NUEVO_PLAZO","FLAG_PERIODO_GRACIA","FLAG_NUEVA_TASA","FLAG_SALDO_CONSOLIDADO","FLAG_PLAZO_NEGOCIACION"] | String |
| creditAnalysis[]*.collection.AdditionalData[].value | Value variable additionalData. | String |
| creditAnalysis[]*.collection.partyAcctRelRec.additionalAcctId | concatenation of obligations. | String |
| creditAnalysis[]*.collection.partyAcctRelRec.flagSelectedOffered | variable mark if the credit is up to date, delinquent or due. Examples: [FDTA, FDTM, FDTP] | String |
| creditAnalysis[]*.collection.extendedDiscount.flagFindeter | Check if the credit has a Findeter benefit or not. | String |
| creditAnalysis[]*.collection.extendedDiscount.flagWalletFindeter | Mark whether or not the credit has a benefit, notifying in response the type of discount applied. | String |
Examples:
Example of Body Request:
Primer Momento:
{
"creditAnalysis": [
{
"collection": {
"transaction": {
"trnRqUID": "2-2230644544"
},
"strategyType": "",
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "79641257"
},
"curAmt": {
"amt": null
},
"partyAcctRelRec": {
"acctId": "4570215061040388",
"amt": null,
"bankAcctStatusCode": "",
"flagSelectedOffered": "",
"additionalAccountId": "",
"additionalAcctId": ""
},
"pmtStatus": {
"flagRecalculate": false
},
"delinqAging": {
"daysCount": null
},
"extendedDiscount": {
"flagFindeter": "",
"flagWalletFindeter": ""
},
"extAcctBal": {
"amt": null,
"curAmt": {
"amt": null
}
},
"acctBal": {
"amt": null
},
"fee": {
"amt": null,
"curAmt": []
},
"extraordinaryFee": [],
"collateralDesc": "",
"collateral": {
"code": ""
},
"capitalizationAcctId": {
"code": ""
},
"dueDt": "",
"insuranceInfo": [],
"intRateInfo": {
"amt": null,
"curAmt": [],
"rate": null
},
"indebtedness": {
"numberOfInstallments": null,
"term": null,
"establishDt": "",
"periodGrace": null,
"amt": null,
"totalPmtCount": null,
"rate": null,
"numAsignInstallments": null
},
"validity": {
"openDt": "",
"endDt": "",
"startDt": ""
},
"offer": {
"viabilityLevel": "",
"flagViability": "true",
"amt": null,
"count": ""
},
"discount": {
"amt": null
},
"causalExceptionInfo": [],
"causalNoViabilitynInfo": [],
"additionalData": []
}
}
]
}Recalculo 1 offer:
{
"creditAnalysis": [
{
"collection": {
"transaction": {
"trnRqUID": "2-2230644544"
},
"strategyType": "PDD",
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "79641257"
},
"curAmt": {
"amt": 0.0
},
"partyAcctRelRec": {
"acctId": "4570215061040388",
"amt": 0.0,
"bankAcctStatusCode": "VIGENTE",
"flagSelectedOffered": "",
"additionalAccountId": "TARJETA CREDITO",
"additionalAcctId": "0"
},
"pmtStatus": {
"flagRecalculate": true
},
"delinqAging": {
"daysCount": 95.0
},
"extendedDiscount": {
"flagFindeter": null,
"flagWalletFindeter": null
},
"extAcctBal": {
"amt": 0.0,
"curAmt": {
"amt": 0.0
}
},
"acctBal": {
"amt": 1529675.0
},
"fee": {
"amt": 0,
"curAmt": [
{
"desc": "COMISION_MIPYME",
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"amt": 0.0
},
{
"desc": "COMISION_USAID",
"amt": 0.0
},
{
"desc": "COMISION_BANCOLDEX",
"amt": 0.0
},
{
"desc": "COMISION_FINAGRO",
"amt": 0.0
}
]
},
"extraordinaryFee": [
{
"desc": "CARGOS_SIP",
"amt": 0.0
},
{
"desc": "CARGOS_CPA",
"amt": 0.0
},
{
"desc": "CARGO_C22",
"amt": 0.0
},
{
"desc": "VAL_OTROS_CARGOS_LEASI",
"amt": 0.0
},
{
"desc": "VALOR_CARGOXCUOTA",
"amt": 0.0
},
{
"desc": "CARGOSDIFERIDOS_PDD",
"amt": 0.0
}
],
"collateralDesc": "",
"collateral": {
"code": "0.0"
},
"capitalizationAcctId": {
"code": ""
},
"dueDt": "",
"insuranceInfo": [
{
"amt": 0.0,
"policyName": "SEGURO_INCENDIO"
},
{
"amt": 0.0,
"policyName": "SEGURO_TERREMOTO"
},
{
"amt": 0.0,
"policyName": "SEGURO_VIDA_CTA_COBRO"
},
{
"amt": 0.0,
"policyName": "SEGURO_DESEMPLEO"
},
{
"amt": 0.0,
"policyName": "SEGURO_RAYO"
},
{
"amt": 0.0,
"policyName": "SEGURO_VENCIDO_RAYO"
},
{
"amt": 0.0,
"policyName": "SEGURO_VENCIDO_TERREMOTO"
},
{
"amt": 0.0,
"policyName": "SEGURO_VENCIDO_INCENDIO"
}
],
"intRateInfo": {
"amt": 269139.0,
"curAmt": [
{
"desc": "CAPITAL",
"rate": 0.0,
"amt": 1529675.0
},
{
"desc": "INTERESES_CORRIENTES",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "INTERESES_MORA",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "SEGUROS",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE07",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE014",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE022",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE016",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CPA",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_SIP",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_BANCOLDEX",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_FINAGRO",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_MIPYME",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_USAID",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "GAC",
"rate": 0.0,
"amt": 0.0
}
],
"rate": 0.0
},
"indebtedness": {
"establishDt": "2024-05-06",
"numberOfInstallments": 0.0,
"amt": 0.0,
"totalPmtCount": 0.0,
"rate": 0.0,
"periodGrace": 0.0,
"numAsignInstallments": 0.0,
"term": 0.0
},
"validity": {
"startDt": "2024-05-06",
"openDt": "2024-07-22",
"endDt": "2024-05-06"
},
"offer": {
"flagViability": "true",
"viabilityLevel": "0",
"count": "3.0",
"amt": 0.0
},
"discount": {
"amt": 0.0
},
"causalExceptionInfo": [
{
"name": "EXC_CUOTAS_PAGAS_APLICADAS",
"value": "0"
},
{
"name": "EXC_DIAS_MORA",
"value": "0"
},
{
"name": "EXC_FECHA_EXPEDICION",
"value": "0"
},
{
"name": "EXC_CUOTAS_PAGAS",
"value": "0"
},
{
"name": "EXC_NUMERO_HERRAMIENTAS",
"value": "0"
},
{
"name": "EXC_PLAZO_NEGOCIACION",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA_INCUMPLIDA",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA",
"value": "0"
},
{
"name": "EXC_CARGO_DIFERIDO",
"value": "0"
},
{
"name": "EXC_TIEMPO_ENTRE_HERR",
"value": "0"
}
],
"causalNoViabilitynInfo": [
{
"descriptionDesc": "causalDeNoViabilidadHerremienta1",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia2",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia3",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia4",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia5",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia6",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia7",
"viabilityResult": ""
}
],
"additionalData": [
{
"name": "FLAG_VALOR_PAGO",
"value": "0"
},
{
"name": "FLAG_VALOR_NUEVA_CUOTA",
"value": "1"
},
{
"name": "FLAG_NUEVO_PLAZO",
"value": "0"
},
{
"name": "FLAG_PERIODO_GRACIA",
"value": "0"
},
{
"name": " FLAG_NUEVA_TASA",
"value": "0"
},
{
"name": "FLAG_SALDO_CONSOLIDADO",
"value": "0"
},
{
"name": "FLAG_PLAZO_NEGOCIACION",
"value": "0"
}
]
}
}
]
}Recalculo more 1 offer:
{
"creditAnalysis": [
{
"collection": {
"transaction": {
"trnRqUID": "2-2230644544"
},
"strategyType": "CNT",
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "79641257"
},
"curAmt": {
"amt": 534329.0
},
"partyAcctRelRec": {
"acctId": "4570215061040388",
"amt": 1602987.0,
"bankAcctStatusCode": "VIGENTE",
"flagSelectedOffered": "",
"additionalAccountId": "TARJETA CREDITO",
"additionalAcctId": "0"
},
"pmtStatus": {
"flagRecalculate": true
},
"delinqAging": {
"daysCount": 95.0
},
"extendedDiscount": {
"flagFindeter": "",
"flagWalletFindeter": ""
},
"extAcctBal": {
"amt": 0.0,
"curAmt": {
"amt": 0.0
}
},
"acctBal": {
"amt": 1529675.0
},
"fee": {
"amt": 0,
"curAmt": [
{
"desc": "COMISION_MIPYME",
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"amt": 0.0
},
{
"desc": "COMISION_USAID",
"amt": 0.0
},
{
"desc": "COMISION_BANCOLDEX",
"amt": 0.0
},
{
"desc": "COMISION_FINAGRO",
"amt": 0.0
}
]
},
"extraordinaryFee": [
{
"desc": "CARGOS_SIP",
"amt": 0.0
},
{
"desc": "CARGOS_CPA",
"amt": 0.0
},
{
"desc": "CARGO_C22",
"amt": 0.0
},
{
"desc": "VAL_OTROS_CARGOS_LEASI",
"amt": 0.0
},
{
"desc": "VALOR_CARGOXCUOTA",
"amt": 0.0
},
{
"desc": "CARGOSDIFERIDOS_PDD",
"amt": 0.0
}
],
"collateralDesc": "",
"collateral": {
"code": "0.0"
},
"capitalizationAcctId": {
"code": ""
},
"dueDt": "",
"insuranceInfo": [
{
"amt": 0,
"policyName": "SEGURO_INCENDIO"
},
{
"amt": 0,
"policyName": "SEGURO_TERREMOTO"
},
{
"amt": 0,
"policyName": "SEGURO_VIDA_CTA_COBRO"
},
{
"amt": 0,
"policyName": "SEGURO_DESEMPLEO"
},
{
"amt": 0,
"policyName": "SEGURO_RAYO"
},
{
"amt": 0,
"policyName": "SEGURO_VENCIDO_RAYO"
},
{
"amt": 0,
"policyName": "SEGURO_VENCIDO_TERREMOTO"
},
{
"amt": 0,
"policyName": "SEGURO_VENCIDO_INCENDIO"
}
],
"intRateInfo": {
"amt": 269139.0,
"curAmt": [
{
"desc": "CAPITAL",
"rate": 0.0,
"amt": 1529675.00
},
{
"desc": "INTERESES_CORRIENTES",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "INTERESES_MORA",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "SEGUROS",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CE07",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CE014",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CE022",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CE016",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CPA",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_SIP",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_BANCOLDEX",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_FINAGRO",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_MIPYME",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_USAID",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "GAC",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "INTERES_ANTICIPADOS",
"amt": 0.0
},
{
"desc": "INTERES_CORTE",
"amt": 0.0
},
{
"desc": "INTERES_MORA",
"amt": 6646.0
}
],
"rate": 0.0
},
"indebtedness": {
"numberOfInstallments": 0.0,
"term": 0.0,
"establishDt": "2024-10-16",
"periodGrace": 0.0,
"amt": 0.0,
"totalPmtCount": 0.0,
"rate": 0.0,
"numAsignInstallments": 3.0
},
"validity": {
"openDt": "2024-07-18",
"endDt": "2024-10-16",
"startDt": "2024-10-16"
},
"offer": {
"viabilityLevel": "1",
"flagViability": "true",
"amt": null,
"count": "3.0"
},
"discount": {
"amt": 63312.0
},
"causalExceptionInfo": [
{
"name": "EXC_CUOTAS_PAGAS_APLICADAS",
"value": "0"
},
{
"name": "EXC_DIAS_MORA",
"value": "0"
},
{
"name": "EXC_FECHA_EXPEDICION",
"value": "0"
},
{
"name": "EXC_CUOTAS_PAGAS",
"value": "0"
},
{
"name": "EXC_NUMERO_HERRAMIENTAS",
"value": "0"
},
{
"name": "EXC_PLAZO_NEGOCIACION",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA_INCUMPLIDA",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA",
"value": "0"
},
{
"name": "EXC_CARGO_DIFERIDO",
"value": "0"
},
{
"name": "EXC_TIEMPO_ENTRE_HERR",
"value": "0"
}
],
"causalNoViabilitynInfo": [
{
"descriptionDesc": "causalDeNoViabilidadHerremienta1",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia2",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia3",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia4",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia5",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia6",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia7",
"viabilityResult": ""
}
],
"additionalData": [
{
"name": "FLAG_VALOR_PAGO",
"value": "0"
},
{
"name": "FLAG_VALOR_NUEVA_CUOTA",
"value": "0"
},
{
"name": "FLAG_NUEVO_PLAZO",
"value": "0"
},
{
"name": "FLAG_PERIODO_GRACIA",
"value": "0"
},
{
"name": " FLAG_NUEVA_TASA",
"value": "0"
},
{
"name": "FLAG_SALDO_CONSOLIDADO",
"value": "0"
},
{
"name": "FLAG_PLAZO_NEGOCIACION",
"value": "0"
}
]
}
},
{
"collection": {
"transaction": {
"trnRqUID": "2-2230644544"
},
"strategyType": "PDD",
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "79641257"
},
"curAmt": {
"amt": 0.0
},
"partyAcctRelRec": {
"acctId": "4570215061040388",
"amt": 0.0,
"bankAcctStatusCode": "VIGENTE",
"flagSelectedOffered": "",
"additionalAccountId": "TARJETA CREDITO",
"additionalAcctId": "0"
},
"pmtStatus": {
"flagRecalculate": true
},
"delinqAging": {
"daysCount": 95.0
},
"extendedDiscount": {
"flagFindeter": "",
"flagWalletFindeter": ""
},
"extAcctBal": {
"amt": 0.0,
"curAmt": {
"amt": 0.0
}
},
"acctBal": {
"amt": 1529675.0
},
"fee": {
"amt": 0,
"curAmt": [
{
"desc": "COMISION_MIPYME",
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"amt": 0.0
},
{
"desc": "COMISION_USAID",
"amt": 0.0
},
{
"desc": "COMISION_BANCOLDEX",
"amt": 0.0
},
{
"desc": "COMISION_FINAGRO",
"amt": 0.0
}
]
},
"extraordinaryFee": [
{
"desc": "CARGOS_SIP",
"amt": 0.0
},
{
"desc": "CARGOS_CPA",
"amt": 0.0
},
{
"desc": "CARGO_C22",
"amt": 0.0
},
{
"desc": "VAL_OTROS_CARGOS_LEASI",
"amt": 0.0
},
{
"desc": "VALOR_CARGOXCUOTA",
"amt": 0.0
},
{
"desc": "CARGOSDIFERIDOS_PDD",
"amt": 0.0
}
],
"collateralDesc": "",
"collateral": {
"code": "0.0"
},
"capitalizationAcctId": {
"code": ""
},
"dueDt": "",
"insuranceInfo": [
{
"amt": 0,
"policyName": "SEGURO_INCENDIO"
},
{
"amt": 0,
"policyName": "SEGURO_TERREMOTO"
},
{
"amt": 0,
"policyName": "SEGURO_VIDA_CTA_COBRO"
},
{
"amt": 0,
"policyName": "SEGURO_DESEMPLEO"
},
{
"amt": 0,
"policyName": "SEGURO_RAYO"
},
{
"amt": 0,
"policyName": "SEGURO_VENCIDO_RAYO"
},
{
"amt": 0,
"policyName": "SEGURO_VENCIDO_TERREMOTO"
},
{
"amt": 0,
"policyName": "SEGURO_VENCIDO_INCENDIO"
}
],
"intRateInfo": {
"amt": 269139.0,
"curAmt": [
{
"desc": "CAPITAL",
"rate": 0.0,
"amt": 1529675.00
},
{
"desc": "INTERESES_CORRIENTES",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "INTERESES_MORA",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "SEGUROS",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE07",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE014",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE022",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE016",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CPA",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_SIP",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_BANCOLDEX",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_FINAGRO",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_MIPYME",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_USAID",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "GAC",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "INTERES_ANTICIPADOS",
"amt": 0.0
},
{
"desc": "INTERES_CORTE",
"amt": 0.0
},
{
"desc": "INTERES_MORA",
"amt": 6646.0
}
],
"rate": 0.0
},
"indebtedness": {
"numberOfInstallments": 3.0,
"term": 0.0,
"establishDt": "2024-05-06",
"periodGrace": 0.0,
"amt": 0.0,
"totalPmtCount": 0.0,
"rate": 0.0,
"numAsignInstallments": 0.0
},
"validity": {
"openDt": "2024-05-06",
"endDt": "2024-05-06",
"startDt": "2024-05-06"
},
"offer": {
"viabilityLevel": "0",
"flagViability": "true",
"amt": null,
"count": "3.0"
},
"discount": {
"amt": 0.0
},
"causalExceptionInfo": [
{
"name": "EXC_CUOTAS_PAGAS_APLICADAS",
"value": "0"
},
{
"name": "EXC_DIAS_MORA",
"value": "0"
},
{
"name": "EXC_FECHA_EXPEDICION",
"value": "0"
},
{
"name": "EXC_CUOTAS_PAGAS",
"value": "0"
},
{
"name": "EXC_NUMERO_HERRAMIENTAS",
"value": "0"
},
{
"name": "EXC_PLAZO_NEGOCIACION",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA_INCUMPLIDA",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA",
"value": "0"
},
{
"name": "EXC_CARGO_DIFERIDO",
"value": "0"
},
{
"name": "EXC_TIEMPO_ENTRE_HERR",
"value": "0"
}
],
"causalNoViabilitynInfo": [
{
"descriptionDesc": "causalDeNoViabilidadHerremienta1",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia2",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia3",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia4",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia5",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia6",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia7",
"viabilityResult": ""
}
],
"additionalData": [
{
"name": "FLAG_VALOR_PAGO",
"value": "0"
},
{
"name": "FLAG_VALOR_NUEVA_CUOTA",
"value": "0"
},
{
"name": "FLAG_NUEVO_PLAZO",
"value": "0"
},
{
"name": "FLAG_PERIODO_GRACIA",
"value": "0"
},
{
"name": " FLAG_NUEVA_TASA",
"value": "0"
},
{
"name": "FLAG_SALDO_CONSOLIDADO",
"value": "0"
},
{
"name": "FLAG_PLAZO_NEGOCIACION",
"value": "0"
}
]
}
},
{
"collection": {
"transaction": {
"trnRqUID": "2-2230644544"
},
"strategyType": "PDIA",
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "79641257"
},
"curAmt": {
"amt": 0.0
},
"partyAcctRelRec": {
"acctId": "4570215061040388",
"amt": 0.0,
"bankAcctStatusCode": "VIGENTE",
"flagSelectedOffered": "",
"additionalAccountId": "TARJETA CREDITO",
"additionalAcctId": "0"
},
"pmtStatus": {
"flagRecalculate": true
},
"delinqAging": {
"daysCount": 95.0
},
"extendedDiscount": {
"flagFindeter": "",
"flagWalletFindeter": ""
},
"extAcctBal": {
"amt": 0.0,
"curAmt": {
"amt": 0.0
}
},
"acctBal": {
"amt": 1529675.0
},
"fee": {
"amt": 0,
"curAmt": [
{
"desc": "COMISION_MIPYME",
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"amt": 0.0
},
{
"desc": "COMISION_USAID",
"amt": 0.0
},
{
"desc": "COMISION_BANCOLDEX",
"amt": 0.0
},
{
"desc": "COMISION_FINAGRO",
"amt": 0.0
}
]
},
"extraordinaryFee": [
{
"desc": "CARGOS_SIP",
"amt": 0.0
},
{
"desc": "CARGOS_CPA",
"amt": 0.0
},
{
"desc": "CARGO_C22",
"amt": 0.0
},
{
"desc": "VAL_OTROS_CARGOS_LEASI",
"amt": 0.0
},
{
"desc": "VALOR_CARGOXCUOTA",
"amt": 0.0
},
{
"desc": "CARGOSDIFERIDOS_PDD",
"amt": 0.0
}
],
"collateralDesc": "",
"collateral": {
"code": "0.0"
},
"capitalizationAcctId": {
"code": ""
},
"dueDt": "",
"insuranceInfo": [
{
"amt": 0,
"policyName": "SEGURO_INCENDIO"
},
{
"amt": 0,
"policyName": "SEGURO_TERREMOTO"
},
{
"amt": 0,
"policyName": "SEGURO_VIDA_CTA_COBRO"
},
{
"amt": 0,
"policyName": "SEGURO_DESEMPLEO"
},
{
"amt": 0,
"policyName": "SEGURO_RAYO"
},
{
"amt": 0,
"policyName": "SEGURO_VENCIDO_RAYO"
},
{
"amt": 0,
"policyName": "SEGURO_VENCIDO_TERREMOTO"
},
{
"amt": 0,
"policyName": "SEGURO_VENCIDO_INCENDIO"
}
],
"intRateInfo": {
"amt": 269139.0,
"curAmt": [
{
"desc": "CAPITAL",
"rate": 0.0,
"amt": 1529675.00
},
{
"desc": "INTERESES_CORRIENTES",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "INTERESES_MORA",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "SEGUROS",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CE07",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CE014",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CE022",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CE016",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_CPA",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "CARGOS_SIP",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_BANCOLDEX",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_FINAGRO",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_MIPYME",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "COMISION_USAID",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "GAC",
"rate": 0.5,
"amt": 0.0
},
{
"desc": "INTERES_ANTICIPADOS",
"amt": 0.0
},
{
"desc": "INTERES_CORTE",
"amt": 0.0
},
{
"desc": "INTERES_MORA",
"amt": 6646.0
}
],
"rate": 0.0
},
"indebtedness": {
"numberOfInstallments": 3.0,
"term": 0.0,
"establishDt": "2024-05-06",
"periodGrace": 0.0,
"amt": 0.0,
"totalPmtCount": 0.0,
"rate": 0.0,
"numAsignInstallments": 0.0
},
"validity": {
"openDt": "2024-05-06",
"endDt": "2024-05-06",
"startDt": "2024-05-06"
},
"offer": {
"viabilityLevel": "1",
"flagViability": "true",
"amt": null,
"count": "3.0"
},
"discount": {
"amt": 63312.0
},
"causalExceptionInfo": [
{
"name": "EXC_CUOTAS_PAGAS_APLICADAS",
"value": "0"
},
{
"name": "EXC_DIAS_MORA",
"value": "0"
},
{
"name": "EXC_FECHA_EXPEDICION",
"value": "0"
},
{
"name": "EXC_CUOTAS_PAGAS",
"value": "0"
},
{
"name": "EXC_NUMERO_HERRAMIENTAS",
"value": "0"
},
{
"name": "EXC_PLAZO_NEGOCIACION",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA_INCUMPLIDA",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA",
"value": "0"
},
{
"name": "EXC_CARGO_DIFERIDO",
"value": "0"
},
{
"name": "EXC_TIEMPO_ENTRE_HERR",
"value": "0"
}
],
"causalNoViabilitynInfo": [
{
"descriptionDesc": "causalDeNoViabilidadHerremienta1",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia2",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia3",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia4",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia5",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia6",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia7",
"viabilityResult": ""
}
],
"additionalData": [
{
"name": "FLAG_VALOR_PAGO",
"value": "0"
},
{
"name": "FLAG_VALOR_NUEVA_CUOTA",
"value": "0"
},
{
"name": "FLAG_NUEVO_PLAZO",
"value": "0"
},
{
"name": "FLAG_PERIODO_GRACIA",
"value": "0"
},
{
"name": " FLAG_NUEVA_TASA",
"value": "0"
},
{
"name": "FLAG_SALDO_CONSOLIDADO",
"value": "0"
},
{
"name": "FLAG_PLAZO_NEGOCIACION",
"value": "0"
}
]
}
}
]
}Example of Body Response:
{
"responseType": {
"value": "OK"
},
"creditAnalysis": [
{
"collection": {
"transaction": {
"trnRqUID": "2-2230644544"
},
"strategyType": "PDD",
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "79641257"
},
"curAmt": {
"amt": null
},
"partyAcctRelRec": {
"acctId": "4570215061040388",
"amt": 0.0,
"bankAcctStatusCode": "VIGENTE",
"flagSelectedOffered": "",
"additionalAccountId": "",
"additionalAcctId": "0.000000"
},
"pmtStatus": {
"flagRecalculate": true
},
"delinqAging": {
"daysCount": 95.0
},
"extendedDiscount": {
"flagFindeter": null,
"flagWalletFindeter": null
},
"extAcctBal": {
"amt": 0.0,
"curAmt": {
"amt": 0.0
}
},
"acctBal": {
"amt": 1529675.0
},
"fee": {
"amt": 0,
"curAmt": [
{
"desc": "COMISION_MIPYME",
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"amt": null
},
{
"desc": "COMISION_USAID",
"amt": null
},
{
"desc": "COMISION_BANCOLDEX",
"amt": null
},
{
"desc": "COMISION_FINAGRO",
"amt": null
}
]
},
"extraordinaryFee": [
{
"desc": "CARGOS_SIP",
"amt": null
},
{
"desc": "CARGOS_CPA",
"amt": null
},
{
"desc": "CARGO_C22",
"amt": null
},
{
"desc": "VAL_OTROS_CARGOS_LEASI",
"amt": null
},
{
"desc": "VALOR_CARGOXCUOTA",
"amt": null
},
{
"desc": "CARGOSDIFERIDOS_PDD",
"amt": null
}
],
"collateralDesc": "",
"collateral": {
"code": ""
},
"capitalizationAcctId": {
"code": ""
},
"dueDt": "",
"insuranceInfo": [
{
"amt": null,
"policyName": "SEGURO_INCENDIO"
},
{
"amt": null,
"policyName": "SEGURO_TERREMOTO"
},
{
"amt": null,
"policyName": "SEGURO_VIDA_CTA_COBRO"
},
{
"amt": null,
"policyName": "SEGURO_DESEMPLEO"
},
{
"amt": null,
"policyName": "SEGURO_RAYO"
},
{
"amt": null,
"policyName": "SEGURO_VENCIDO_RAYO"
},
{
"amt": null,
"policyName": "SEGURO_VENCIDO_TERREMOTO"
},
{
"amt": null,
"policyName": "SEGURO_VENCIDO_INCENDIO"
}
],
"intRateInfo": {
"amt": 269139.0,
"curAmt": [
{
"desc": "CAPITAL",
"rate": 0.0,
"amt": 1529675.0
},
{
"desc": "INTERESES_CORRIENTES",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "INTERESES_MORA",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "SEGUROS",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE07",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE014",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE022",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CE016",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_CPA",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "CARGOS_SIP",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_BANCOLDEX",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_FINAGRO",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_FNG",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_MIPYME",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "COMISION_USAID",
"rate": 0.0,
"amt": 0.0
},
{
"desc": "GAC",
"rate": 0.0,
"amt": 0.0
}
],
"rate": 0
},
"indebtedness": {
"establishDt": "2024-05-06",
"numberOfInstallments": 0.0,
"amt": 0.0,
"totalPmtCount": 0.0,
"rate": 0.0,
"periodGrace": 0.0,
"numAsignInstallments": "",
"term": 0.0
},
"validity": {
"startDt": "2024-05-06",
"openDt": "2024-07-22",
"endDt": "2024-05-06"
},
"offer": {
"flagViability": "VIABLE",
"viabilityLevel": "0",
"count": "3.0",
"amt": 0.0
},
"discount": {
"amt": 0.0
},
"causalExceptionInfo": [
{
"name": "EXC_CUOTAS_PAGAS_APLICADAS",
"value": ""
},
{
"name": "EXC_DIAS_MORA",
"value": "0"
},
{
"name": "EXC_FECHA_EXPEDICION",
"value": "0"
},
{
"name": "EXC_CUOTAS_PAGAS",
"value": ""
},
{
"name": "EXC_NUMERO_HERRAMIENTAS",
"value": "0"
},
{
"name": "EXC_PLAZO_NEGOCIACION",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA_INCUMPLIDA",
"value": "0"
},
{
"name": "EXC_PERIODO_VIGILANCIA",
"value": "0"
},
{
"name": "EXC_CARGO_DIFERIDO",
"value": "0"
},
{
"name": "EXC_TIEMPO_ENTRE_HERR",
"value": "0"
}
],
"causalNoViabilitynInfo": [
{
"descriptionDesc": "causalDeNoViabilidadHerremienta1",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia2",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia3",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia4",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia5",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia6",
"viabilityResult": ""
},
{
"descriptionDesc": "causalDeNoViabilidadPuestaAlDia7",
"viabilityResult": ""
}
],
"additionalData": [
{
"name": "FLAG_VALOR_PAGO",
"value": "0"
},
{
"name": "FLAG_VALOR_NUEVA_CUOTA",
"value": "1"
},
{
"name": "FLAG_NUEVO_PLAZO",
"value": "0"
},
{
"name": "FLAG_PERIODO_GRACIA",
"value": ""
},
{
"name": " FLAG_NUEVA_TASA",
"value": ""
},
{
"name": "FLAG_SALDO_CONSOLIDADO",
"value": "0"
},
{
"name": "FLAG_PLAZO_NEGOCIACION",
"value": "0"
}
]
}
}
]
}Error Code Response:
| HTTPCode | ErrorCode | ErrorType | Description |
|---|---|---|---|
| OTR | 10001 | OTR | "Error al ejecutar el PL": Cuando se presenta un error en la invocación del PL. |
| OTR | 10002 | OTR | "El objeto de Entrada es nulo": Cuando uno de los campos del request que es obligatorio se envía nulo. |
| OTR | 10007 | OTR | "Error al transformar": Cuando en una de las transformaciones se presenta un error. |
| OTR | 10101 | OTR | "Error en la Consulta del Buro": Cuando se presenta un error al consumir los servicios de CIFIN. |
| OTR | 15001 | OTR | "Error en inesperado en el procesamiento del servicio": Cuando se presenta un error no controlado en la aplicación. |
Diagrama.

- Check collection.
Description:
This service allows Check collection.
Path:
POST: /collections-management/v1/collection:Request Data:
Headers:
| Name | Description | Example | Comments | Required |
|---|---|---|---|---|
| client_id | Identificador del cliente | f1b1247... | SI | |
| client_secret | Clave del cliente | b124731b4... | SI | |
| Authorization | Token Generado | Bearer WxN_AU... | SI | |
| Accept | / | SI | ||
| X-Invoker-Channel | Channel of origin of consumption | Valor fijo 13 (Corresponsal bancario) | SI | |
| X-Invoker-ATMId | Amt code | Enviar espacios | NO | |
| X-Invoker-BranchId | Office code | Campo nuevo – Valor fijo “1108” | SI | |
| X-Invoker-TerminalId | Term code | Codigo de la terminal - ¿Como identifica SER las terminales de los PDS? | SI | |
| X-Invoker-Component | Component | Enviar espacios | NO | |
| X-Invoker-UserIPAddress | Client IP Address | IP de la terminal que ejecuta la aplicación | SI | |
| X-Invoker-ServerIPAddress | Server IP Address | IP servidor de aplicación que ejecuta la transacción | SI | |
| X-Invoker-UserMACAddress | Client MAC Address | Dato esperable, si por limitantes técnicas o de seguridad no se pudiera obtener, se enviaria completo con ceros en formato MAC | NO | |
| X-Invoker-ServerMACAddress | Server MAC Address | Dato esperable, si por limitantes técnicas o de seguridad no se pudiera obtener, se enviaria completo con ceros en formato MAC | NO | |
| X-Invoker-ProcessDate | Process date | Formato AAA-MM-DD | SI | |
| X-Invoker-TxId | Id TX | Dato esperable, identificador unico de la transacción/llamado al core. Largo máximo 16 caracteres. APIF+fecha juliana + 32 + Número de Autorización APIF : Es una constante que identifica que la transacción se realizó por el canal de Corresponsal bancario La fecha Juliana: Son 4 dígitos, en donde el primero corresponde al último dígito del año en curso y los 3 siguientes al número de días transcurridos en el año hasta la fecha actual. Código del banco= 32 Número de Autorización: son 10 dígitos generados de manera secuencial. Ejemplo: APIF4087320000000001 | SI | |
| X-Invoker-SessionKey | Session key | TOKEN del consumo al API 30 primeras posiciones | SI | |
| X-Invoker-Source | Origin | Campo nuevo – Valor fijo “18” | NO | |
| X-Invoker-Country | Country | Campo nuevo – Valor fijo “CO” | SI | |
| X-Invoker-ProcessBpmId | ID BPM process | Enviar espacios | NO | |
| X-Invoker-ProcessId | Process ID | Obligatorio solo para los servicios de Aplicación contable, opcional para consulta, se debe enviar los ultimos 11 digitos del campo X-Invoker-TxId alineados a la derecha con cero a la izquierda asi: X-Invoker-TxId:APIF4087320000000001 X-Invoker-ProcessId:020000000001 | SI | |
| X-Invoker-Network | Net | Enviar espacios | NO | |
| X-Invoker-subChannel | Subchannel with which the transaction must be registered | Valor fijo “07” | SI | |
| X-Invoker-User | User | Valor fijo “NEWCBSER” | SI | |
| X-Invoker-Action | Action | C --> Create (Aplicación de negocio) R -- > Read (Consulta) | SI | |
| X-Invoker-Destination | Destination | Enviar espacios | NO | |
| X-Invoker-ModifierUser | Modification user | Enviar espacios | SI | |
| X-Invoker-ReferencedNumber | Reference number | Enviar espacios | NO | |
| X-Invoker-RequestNumber | Request number | Enviar espacios | NO | |
| X-Invoker-CustId | CustId | Enviar espacios | NO | |
| X-Ident-DeviceFingerPrint | DeviceFingerPrint | Enviar espacios | NO | |
| x-invoker-ally | Client code | Enviar espacios | NO |
Request Body:
| Field Name | Description | Type | Comments |
|---|---|---|---|
| trn.transactionHour | Hora local de la transacción | String | HHMMSS ejemplo: 15:37:59 |
| trn.code | Código del punto de servicio | String | Código sitio:123456789123456 |
| trn.RefId | Codigo convenio | String | Ejemplo: 15907356 |
| trn.EANCode | codigo EAN | String | Se envia únicamente cuando la captura del pago es con código de barras si es captura manual este campo va en espacios.Justificado a la izquierda con blancos a la derecha |
| trn.curAmt.amt | referencia de pago | String | Numero de producto |
| trn.trnRqUID | Número de auditoría para seguimiento del sistema | String | Numero unico de 6 digitos generado por el canal (Número asignado por el originador del requerimiento de transacción. - P11) |
| trn.branchName | Nombre PDS | String | Nombre PDS ejemplo: MI OFICINA BETTY |
| trn.cityId | Codigo Dane Municipio | String | Codigo georeferenciacion DANE longitud 6, ejemplo: 25386 (LA MESA) |
| trn.city | Nombre Dane municipio | String | Nombre georeferenciacion DANE ejemplo: LA MESA |
| trn.stateProv | Co0digo Dane departamento | String | Codigo georeferenciacion DANE longitud 2 ejemplo: 25 (CUNDINAMARCA) |
| trn.aditionalData[]{"name": "ref1", "value":"0399200339917"} | Referencia de pago 1 | String | Dato que contiene la informacion para la referencia 1 Ejemplo [0399200339917 ] |
| trn.aditionalData[]{"name": "ref1", "value":"0399200339917"} | Nombre referencia 1 | String | Dato que contiene el nombre para la referencia 1 [Numero de Producto ] |
| trn.aditionalData[]{"name": "ref2", "value":"0399200339917"} | Referencia de pago 2 | String | Dato que contiene la informacion para la referencia 1 Ejemplo [Pago pension ] |
| trn.aditionalData[]{"name": "ref2", "value":"0399200339917"} | Nombre referencia 2 | String | Dato que contiene el nombre para la referencia 1 [Descripcion ] |
| trn.aditionalData[]{"name": "ref3", "value":"0399200339917"} | Referencia de pago 3 | String | Dato que contiene la informacion para la referencia 3 |
| trn.aditionalData[]{"name": "ref3", "value":"0399200339917"} | Nombre referencia 3 | String | Dato que contiene el nombre para la referencia 3 |
| trn.depAcctId.acctId | CuentaCorresponsalBancario | String | Cuenta corresponsal bancario [83000109863] |
| trn.totalCurAmt.amt | Valor | Number | Si se hace lectura de código de barras y el tag 3900 (es decir el campo valor) está presente, se debe enviar el valor leído. Si no se está haciendo lectura de código de barras o el tag 3900 no está presente en el código de barras leído, se debe enviar ceros.. |
| trn.flagAnotherAmt | Flag ingreso valor | String | Flag para concer si el cliente paga otro valor que no es minimo ni maximo depende de la configuracion del convenio |
| trn.RefType | Tipo de recaudo | String | Codigo de tipoRecaudo de la Interface de Convenios |
| trn.EffDt | Fecha Pago | String | Se envia únicamente cuando la captura del pago es con código de barras, si es captura manual este campo va en espacios.Justificado a la izquierda con blancos a la derecha |
| trn.refName | Nombre Convenio | String | Nombre del convenio de recaudo |
Request Example:
{
"trn": {
"transactionHour": "15:37:59",
"code": "123456789123456",
"refId": "123456",
"eanCode": "",
"curAmt": {
"amt": "99"
},
"trnRqUID": "123456",
"branchName": "MI OFICINA BETTY",
"cityId": "25386",
"city": "LA MESA",
"stateProv": "25",
"aditionalData": [
{
"name": "Nombre referencia 1",
"value":"Referencia de pago 1"
},
{
"name": "Nombre referencia 2",
"value":"Referencia de pago 2"
},
{
"name": "Nombre referencia 3",
"value":"Referencia de pago 3"
}
],
"depAcctId": {
"acctId": "12321414"
},
"totalCurAmt": {
"amt": 99
},
"flagAnotherAmt": "0",
"refType": "",
"effDt": "",
"refName": ""
}
}Response Body:
| Field Name | Description | Type | Comments |
|---|---|---|---|
| trn.personName.fullName | Nombre del titular | String | Nombre del titular |
| trn.approvalId | Numero Autorizacion | String | Codigo autorizacion |
| trn.aditionalData.CurAmt[].{"name": "ref1", "value":"0399200339917"} | Valor a pagar 1 | String | |
| trn.aditionalData.CurAmt[].{"name": "ref1", "value":"0399200339917"} | Valor a pagar 2 | String | |
| trn.PmtRefId | Codigo de notificacion | String | |
| trn.DueDt | Fecha Vencimiento | String | |
| trn.flagUpdate | Permite modificar valor | String | |
| trn.acctId | Numero de cuenta | String | |
| trn.refType | Tipo de recaudo | String | No requerido |
Success Response Example:
{
"responseType": {
"value": "OK"
},
"trn": {
"personName": {
"fullName": "full name"
},
"approvalId": "Z69599FB119FB12927E1",
"aditionalData": {
"curAmt": [
{
"name": "Nombre referencia 1",
"value": 99
},
{
"name": "Nombre referencia 2",
"value": 99
}
]
},
"pmtRefId": "",
"dueDt": "",
"flagUpdate": "1",
"acctId": "",
"refType": ""
}
}
Response Error Example:
{
"responseType": {
"value": "ER500"
},
"responseDetail": {
"errorCode": "",
"errorDesc": "",
"errorType": ""
}
}Diagram of sequence