La API de Registro de Desembargo tiene como funcionalidad radicar la solicitud de levantamiento del embargo.
Bancolombia API Working Group
- Protocols: HTTPS
production
development
https://sbapi.bancolombia.com
Base Gateway API Endpoint
Rutas
/registry
post /registry
Radicación de solicitudes de desembargo.
La API de Registro de Desembargo tiene como funcionalidad radicar la solicitud de levantamiento del embargo.
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:write:app
Registrar una solicitud de embargo o desembargo
registryReq
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.
default
Error inesperado.
Solicitud de ejemplo
Respuesta de ejemplo
POST https://sbapi.bancolombia.com/v1/operations/specific-product/consumer-services/attachment-lift/registry
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 /registry
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:write:app
Registrar una solicitud de embargo o 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-lift/registry
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",
"required": [
"requestUnattachableId",
"requestAttachableId",
"subsidiary",
"demandant",
"defendant",
"judicialOffice"
],
"properties": {
"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": "234560987600000",
"maxLength": 23,
"minLength": 15
},
"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 a la cual aplica el desembargo.",
"example": "231234987650000",
"maxLength": 23,
"minLength": 15
},
"subsidiary": {
"$ref": "#\/definitions\/subsidiary"
},
"demandant": {
"$ref": "#\/definitions\/demandant"
},
"defendant": {
"$ref": "#\/definitions\/defendant"
},
"judicialOffice": {
"$ref": "#\/definitions\/judicialOffice"
},
"judicialAnnexes": {
"$ref": "#\/definitions\/judicialAnnexes"
}
}
}
}
}
}
Información correspondiente a las Filiales a las cuales esta dirigida la solicitud.
{
"type": "array",
"items": {
"type": "object",
"required": [
"subsidiaryNit"
],
"properties": {
"subsidiaryNit": {
"type": "string",
"description": "Número de identificación tributario de la filial (NIT) con dígito de verificación",
"example": "900123456-1",
"maxLength": 11,
"minLength": 11
},
"subsidiaryName": {
"type": "string",
"description": "Nombre de la filial a la que está dirigida la solicitud",
"example": "BANCOLOMBIA PANAMA",
"maxLength": 80,
"minLength": 3
}
}
}
}
Información correspondiente a los Demandantes en la Orden de Embargo.
{
"type": "array",
"items": {
"type": "object",
"properties": {
"customerDocumentType": {
"type": "string",
"description": "Tipo de documento del demandante.",
"example": "CC",
"enum": [
"CC",
"CE",
"NIT",
"PAS"
]
},
"customerDocumentNumber": {
"type": "string",
"description": "Número de documento del demandante con dígito de verificación cuando aplique.",
"example": "15360300",
"maxLength": 16,
"minLength": 5
}
},
"additionalProperties": false
}
}
Información correspondiente al Demandado en la Orden de Embargo.
{
"type": "object",
"properties": {
"customerDocumentType": {
"type": "string",
"description": "Tipo de documento del demandado.",
"example": "CC",
"enum": [
"CC",
"CE",
"NIT",
"PAS"
]
},
"customerDocumentNumber": {
"type": "string",
"description": "Número de documento del demandado con dígito de verificación cuando aplique.",
"example": "21811845",
"maxLength": 16,
"minLength": 5
}
},
"additionalProperties": false
}
Documentos anexos a la solicitud
{
"type": "object",
"properties": {
"dataNumber": {
"type": "string",
"description": "Número de oficio con el que la entidad de cobro coactivo o el organismo judicial identifica el documento.",
"example": "100208221",
"maxLength": 15,
"minLength": 1
},
"dataFile": {
"type": "string",
"description": "Archivo digital de la solicitud.",
"example": "T2ZpY2lvIGRlbCBkZXNlbWJhcmdv"
},
"dataDateOffice": {
"type": "string",
"format": "date",
"description": "Fecha del oficio (AAAA-MM-DD).",
"example": "2019-09-13"
}
},
"additionalProperties": false
}
Documentos anexos a la solicitud.
{
"type": "array",
"items": {
"type": "object",
"properties": {
"dataNumber": {
"type": "string",
"description": "Número de oficio con el que la entidad de cobro coactivo o el organismo judicial identifica el documento.",
"example": "A1000002",
"maxLength": 15,
"minLength": 1
},
"dataFile": {
"type": "string",
"description": "Archivo digital de la solicitud.",
"example": "RG9jdW1lbnRvIGFuZXhvIGFsIGVtYmFyZ28="
}
},
"additionalProperties": false
}
}
{
"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": [
"attachmentId"
],
"properties": {
"attachmentId": {
"type": "string",
"description": "Identificador único generado por la entidad financiera de la solicitud de desembargo registrada.",
"example": "0010072019071110000",
"maxLength": 19,
"minLength": 19
}
}
}
}
}
},
"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
}