La API de Registro de Solicitud de Embargo tiene como funcionalidad radicar la solicitud de embargo.
Bancolombia API Working Group
- Protocols: HTTPS
production
development
https://sbapi.bancolombia.com
Base Gateway API Endpoint
Paths
/registry
post /registry
validateFund
Radicación de solicitudes de embargo.
La API de Registro de Solicitud de Embargo tiene como funcionalidad radicar la solicitud de 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.
Token URL
https://api.us.apiconnect.ibmcloud.com/bancolombiabluemix-dev/sandbox/v1/security/oauth-otp-pymes/oauth2/token
Scopes
Attachment:write:app
Registrar una solicitud de embargo o desembargo.
registryReq
Required in body
object
Content-Type
Optional in header
string
application/vnd.bancolombia.v1+json
Accept
Optional in header
string
application/vnd.bancolombia.v1+json
200
Successful response.
400
Error in the request.
401
Incorrect credentials.
403
You do not have permissions to access the resource.
404
Resource not found.
409
Resource state has conflicts with data of the request.
500
Internal server error.
502
Error in the service provider response.
503
Service unavailable.
504
Service provider response time exceeded.
default
Unexpected Error.
Example Request
Example Response
POST https://sbapi.bancolombia.com/v1/operations/specific-product/consumer-services/attachment-registry/registry
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
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.
Token URL
https://api.us.apiconnect.ibmcloud.com/bancolombiabluemix-dev/sandbox/v1/security/oauth-otp-pymes/oauth2/token
Scopes
Attachment:write:app
Registrar una solicitud de embargo o desembargo.
Accept
Optional in header
string
application/vnd.bancolombia.v1+json
200
Respuesta exitosa.
Example Request
Example Response
HEAD https://sbapi.bancolombia.com/v1/operations/specific-product/consumer-services/attachment-registry/registry
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
Definitions
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"requestAttachableId",
"requestAmount",
"bankId",
"requestTypeAction",
"accountNumber",
"accountType",
"requestExceptionUnattachable",
"requestAttachmentLimit",
"subsidiary",
"demandant",
"defendant",
"judicialOffice"
],
"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
},
"requestAmount": {
"type": "number",
"format": "double",
"description": "Monto del embargo.",
"example": 1500000000.98,
"maxLength": 16,
"minLength": 2
},
"requestTypeAction": {
"type": "string",
"description": "Tipo de acción solicitada por la entidad de cobro coactivo o el organismo judicial.",
"example": "PAGAR",
"enum": [
"CONGELAR",
"PAGAR"
]
},
"requestPercentage": {
"type": "number",
"format": "double",
"description": "Porcentaje de embargo solicitado sobre el monto de los productos [0, 100].",
"example": 15,
"maxLength": 3,
"minLength": 2
},
"bankId": {
"type": "string",
"description": "Identificador del banco al que se debe pagar la orden de embargo.",
"example": "02",
"maxLength": 2,
"minLength": 2
},
"accountNumber": {
"type": "string",
"description": "Número de la cuenta a la que se debe pagar la orden embargo.",
"example": "01530251620",
"maxLength": 15,
"minLength": 9
},
"accountType": {
"type": "string",
"description": "Tipo de la cuenta a la que se debe pagar la orden de embargo.",
"example": "CUENTA DE AHORRO JUDICIAL",
"enum": [
"CUENTA DE AHORRO JUDICIAL",
"CUENTA CORRIENTE"
]
},
"requestExceptionUnattachable": {
"type": "boolean",
"description": "Le permite a las entidades de cobro coactivo u organismos judiciales solicitar una excepción para aquellas cuentas definidas como innembargables.",
"example": false,
"enum": [
true,
false
]
},
"requestAttachmentLimit": {
"type": "string",
"description": "Determina el límite de inembargabilidad de acuerdo con el tipo de entidad judicial que realiza la solicitud del embargo (Ordinaria, Coactiva).",
"example": "ORDINARIO",
"enum": [
"ORDINARIO",
"COACTIVO"
]
},
"subsidiary": {
"$ref": "#\/definitions\/subsidiary"
},
"demandant": {
"$ref": "#\/definitions\/demandant"
},
"defendant": {
"$ref": "#\/definitions\/defendant"
},
"judicialOffice": {
"$ref": "#\/definitions\/judicialOffice"
},
"judicialAnnexes": {
"$ref": "#\/definitions\/judicialAnnexes"
},
"seizureJudgment": {
"$ref": "#\/definitions\/seizureJudgment"
}
}
}
}
}
}
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
},
"customerName": {
"type": "string",
"description": "Nombre completo del demandante.",
"example": "Juan Roberto Franco",
"maxLength": 100,
"minLength": 1
}
},
"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
},
"customerName": {
"type": "string",
"description": "Nombre completo del demandado.",
"example": "Pedro Zapata Restrepo",
"maxLength": 100,
"minLength": 1
}
},
"additionalProperties": false
}
Documento principal de 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": "T2ZpY2lvIGRlbCBlbWJhcmdv"
},
"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 con el que la entidad de cobro coactivo o el organismo judicial identifica el documento emitido.",
"example": "A1000001",
"maxLength": 15,
"minLength": 1
},
"dataFile": {
"type": "string",
"description": "Archivo digital de la solicitud.",
"example": "RG9jdW1lbnRvIGFuZXhvIGFsIGVtYmFyZ28="
}
},
"additionalProperties": false
}
}
Documento anexo de la sentencia de embargabilidad.
{
"type": "object",
"properties": {
"dataNumber": {
"type": "string",
"description": "Número 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": "RG9jdW1lbnRvIGFuZXhvIHNlbnRlbmNpYSBkZSBlbWJhcmdhYmlsaWRhZA=="
}
},
"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 del embargo registrada.",
"example": "0010072019071100000",
"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
}