La API permite consultar el detalle de una solicitud de embargo o desembargo cuyo proceso ha finalizado.
Bancolombia API Working Group
- Protocols: HTTPS
production
development
https://sbapi.bancolombia.com
Base Gateway API Endpoint
Rutas
/validate
post /validate
Consulta el detalle del estado de una solicitud finalizada.
La API permite consultar el detalle de una solicitud de embargo o desembargo cuyo proceso ha finalizado.
Security - OAuth Provider from OTP Pymes
Security - OAuth Provider from OTP Pymes
(oauth2 application)
Expone los formularios para validar la identidad y autorización del usuario.
URL de señal
https://api.us.apiconnect.ibmcloud.com/bancolombiabluemix-dev/sandbox/v1/security/oauth-otp-pymes/oauth2/token
Ámbitos
Attachment:read:app
Consulta el estado de una solicitud de embargo/desembargo
validateReq
Obligatorio en body
object
Content-Type
Opcional en header
string
application/vnd.bancolombia.v1+json
Accept
Opcional en header
string
application/vnd.bancolombia.v1+json
200
Respuesta exitosa.
400
Error en la solicitud.
401
Credenciales incorrectas.
403
No tiene permisos para acceder al recurso.
404
Recurso no encontrado.
409
El estado del recurso presenta conflictos con los datos de la solicitud.
500
Error interno del servidor.
502
Error en la respuesta del proveedor del servicio.
503
Servicio no disponible.
504
Tiempo de respuesta del proveedor del servicio excedido.
Solicitud de ejemplo
Respuesta de ejemplo
POST https://sbapi.bancolombia.com/v1/operations/specific-product/consumer-services/attachment-validate-details/validate
Intentar esta operación
Sin respuesta. Se trata de una llamada de contenido mezclada. No es posible probar las API de HTTP desde un sitio de portal seguro HTTPS y viceversa.
Sin respuesta. Esta es una llamada de orígenes cruzados. Asegúrese de que el servidor acepta solicitudes de este portal. O si se utilizan certificados SSL con autofirma, pegue el URL anterior en su navegador para aceptar el certificado antes de volverlo a intentar. (En Internet Explorer debe ser la misma pestaña de navegador.).
head /validate
validateFund
Operación de monitoreo.
Security - OAuth Provider from OTP Pymes
Security - OAuth Provider from OTP Pymes
(oauth2 application)
Expone los formularios para validar la identidad y autorización del usuario.
URL de señal
https://api.us.apiconnect.ibmcloud.com/bancolombiabluemix-dev/sandbox/v1/security/oauth-otp-pymes/oauth2/token
Ámbitos
Attachment:read:app
Consulta el estado de una solicitud de embargo/desembargo
Accept
Opcional en header
string
application/vnd.bancolombia.v1+json
200
Respuesta exitosa.
Solicitud de ejemplo
Respuesta de ejemplo
HEAD https://sbapi.bancolombia.com/v1/operations/specific-product/consumer-services/attachment-validate-details/validate
Intentar esta operación
Sin respuesta. Se trata de una llamada de contenido mezclada. No es posible probar las API de HTTP desde un sitio de portal seguro HTTPS y viceversa.
Sin respuesta. Esta es una llamada de orígenes cruzados. Asegúrese de que el servidor acepta solicitudes de este portal. O si se utilizan certificados SSL con autofirma, pegue el URL anterior en su navegador para aceptar el certificado antes de volverlo a intentar. (En Internet Explorer debe ser la misma pestaña de navegador.).
Definiciones
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attachmentId": {
"type": "string",
"description": "Identificador único generado por la entidad financiera de la solicitud de embargo o desembargo registrada",
"example": "0010072019071100000",
"maxLength": 19,
"minLength": 19
},
"startDate": {
"format": "date",
"description": "Fecha a partir de la cual se desea realizar la consulta con respecto al cambio del estado (AAAA-MM-DD).",
"example": "2020-08-10"
},
"endDate": {
"format": "date",
"description": "Fecha hasta la cual se desea realizar la consulta con respecto al cambio del estado (AAAA-MM-DD).",
"example": "2020-08-10"
},
"attachmentState": {
"type": "string",
"description": "Estado actual de la solicitud de embargo o desembargo.",
"enum": [
"EN GESTION",
"EMBARGO REGISTRADO",
"DESEMBARGO REGISTRADO",
"RECHAZADA",
"SIN PRODUCTOS FINANCIEROS",
"PRODUCTO INEMBARGABLE"
],
"example": "EMBARGO REGISTRADO"
},
"pagination": {
"$ref": "#\/definitions\/pagination"
}
}
}
}
}
}
{
"type": "object",
"properties": {
"recordsPage": {
"type": "number",
"description": "Número de registros por página a ser devueltos.",
"example": 10,
"maxLength": 2,
"minLength": 1
},
"pageNumber": {
"type": "number",
"description": "Número de página solicitado sobre los resultados encontrados en la consulta.",
"example": 1,
"maxLength": 3,
"minLength": 1
}
}
}
{
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#\/definitions\/meta"
},
"data": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"required": [
"header",
"status"
],
"properties": {
"header": {
"$ref": "#\/definitions\/headerData"
},
"status": {
"type": "object",
"required": [
"totalRecord",
"attachments"
],
"properties": {
"totalRecord": {
"type": "number",
"description": "Cantidad total de registros a devolver para la consulta realizada.",
"example": 1,
"maxLength": 5,
"minLength": 1
},
"attachments": {
"type": "array",
"description": "Registros de las solicitudes de las ordenes de embargo y desembargo segun criterios de consulta.",
"uniqueItems": true,
"items": {
"type": "object",
"required": [
"statusDate",
"attachmentState"
],
"properties": {
"requestAttachableId": {
"type": "string",
"description": "Número de radicado generado por la entidad de cobro coactivo o el organismo judicial que identifica la solicitud de embargo.",
"example": "123498765000000",
"maxLength": 23,
"minLength": 15
},
"requestUnattachableId": {
"type": "string",
"description": "Número de radicado generado por la entidad de cobro coactivo o el organismo judicial que identifica la solicitud de desembargo.",
"example": "null",
"maxLength": 23,
"minLength": 15
},
"statusDate": {
"type": "string",
"description": "Fecha en la cual la solicitud fue actualizada al estado indicado en la petición (AAAA-MM-DD).",
"example": "2020-08-10",
"format": "date"
},
"attachmentState": {
"type": "string",
"description": "Estado actual de la solicitud de embargo o desembargo.",
"example": "EMBARGO REGISTRADO",
"enum": [
"EN GESTION",
"EMBARGO REGISTRADO",
"DESEMBARGO REGISTRADO",
"RECHAZADA",
"SIN PRODUCTOS FINANCIEROS",
"PRODUCTO INEMBARGABLE"
]
},
"judicialOffice": {
"type": "object",
"description": "Documento generado por la entidad bancaria como parte de la respuesta del proceso.",
"required": [
"dataNumber",
"dataFile"
],
"properties": {
"dataNumber": {
"type": "string",
"description": "Número con el que la entidad bancaria identifica el documento emitido (Número de oficio).",
"example": "100208221",
"maxLength": 15,
"minLength": 8
},
"dataFile": {
"type": "string",
"description": "Archivo digital del documento emitido por la entidad bancaria.",
"example": "Q2FydGEgcmVzcHVlc3RhIGRlIGVtYmFyZ28="
}
}
}
}
}
}
}
}
}
}
},
"links": {
"$ref": "#\/definitions\/topLevelLinks"
}
},
"additionalProperties": false
}
Meta-información no estándar que no se puede representar con datos.
{
"type": "object",
"required": [
"_messageId",
"_version",
"_requestDate"
],
"properties": {
"_messageId": {
"type": "string",
"example": "c4e6bd04-5149-11e7-b114-b2f933d5fe66"
},
"_version": {
"type": "string",
"example": "1.0"
},
"_requestDate": {
"type": "string",
"format": "date-time",
"example": "2017-01-24T05:00:00.000Z"
},
"_responseSize": {
"type": "integer",
"example": 1
},
"_clientRequest": {
"type": "string",
"example": "acxff62e-6f12-42de-9012-3e7304418abd"
}
}
}
El "tipo" y "id" para cada registro.
{
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "nameOperation"
},
"id": {
"type": "string",
"example": "nameOperation-2017-01-24T05:00:00.000Z"
}
},
"additionalProperties": false
}
URLs relacionadas con los datos primarios.
{
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/links"
}
]
}
Un objeto de recurso PUEDE contener referencias a otros objetos de recurso
{
"type": "object",
"properties": {
"self": {
"description": "Un mismo miembro, cuyo valor es una URL para los datos de relación",
"type": "string",
"format": "uri"
},
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
{
"type": "object",
"required": [
"meta",
"errors"
],
"properties": {
"meta": {
"$ref": "#\/definitions\/meta"
},
"errors": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#\/definitions\/error"
}
}
},
"additionalProperties": false
}
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"id": {
"description": "Un identificador único para esta aparición particular del problema.",
"type": "string",
"example": "5f2d287a-3a3f-11e7-a919-92ebcb67fe33"
},
"href": {
"description": "Un URI que ** PUEDE ** proporciona más detalles sobre esta ocurrencia particular del problema.",
"type": "string",
"example": "https:\/\/tools.ietf.org\/html\/rfc7231#section-6.5.4"
},
"status": {
"description": "El código de estado HTTP aplicable a este problema, expresado como un valor de cadena.",
"type": "string",
"example": 404
},
"code": {
"description": "Un código de error específico de la aplicación, expresado como un valor de cadena.",
"type": "string",
"example": "BP404"
},
"title": {
"description": "Un breve resumen, legible por el hombre, del problema. ** NO DEBE ** cambiar de ocurrencia a ocurrencia del problema, excepto para propósitos de localización.",
"type": "string",
"example": "Not Found"
},
"detail": {
"description": "Una explicación legible por humanos específica para esta ocurrencia del problema.",
"type": "string",
"example": "Requested resource could not be found"
}
},
"additionalProperties": false
}