Permite identificar si una persona natural o jurídica tiene productos embargables en alguna de las filiales del Grupo Bancolombia.
Bancolombia API Working Group
- Protocols: HTTPS
production
development
https://sbapi.bancolombia.com
Base Gateway API Endpoint
Paths
/attachment-accounts
post /attachment-accounts
Attachment Accounts
Existencia de cuentas embargables.
Capacidad que permite identificar si un cliente Bancolombia tiene productos embargables.
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/v2/security/oauth-otp/oauth2/token
Scopes
Deposit-account:read:user
Consulta de información de las cuentas depósito.
customer
Required in body
object
Datos necesarios para realizar la petición.
Content-Type
Optional in header
string
application/vnd.bancolombia.v1+json
Accept
Optional in header
string
application/vnd.bancolombia.v1+json
201
Success 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/product-specific/accounts-partners/attachment-accounts
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 /attachment-accounts
Attachment Accounts
Capacidad que permite identificar si un cliente Bancolombia tiene productos embargables.
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/v2/security/oauth-otp/oauth2/token
Scopes
Deposit-account:read:user
Consulta de información de las cuentas depósito.
Accept
Optional in header
string
application/vnd.bancolombia.v1+json
200
200 OK
Example Request
Example Response
HEAD https://sbapi.bancolombia.com/v1/operations/product-specific/accounts-partners/attachment-accounts
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": [
"customerDocumentType",
"customerDocumentNumber"
],
"properties": {
"customerDocumentType": {
"type": "string",
"description": "Tipo de identificación de la persona.",
"example": "CC",
"enum": [
"CC",
"CE",
"NIT",
"PAS"
]
},
"customerDocumentNumber": {
"type": "string",
"description": "Número de identificación de la persona con dígito de verificación cuando aplique.",
"example": "15290489",
"maxLength": 16,
"minLength": 5
}
}
}
}
}
}
{
"properties": {
"header": {
"$ref": "#\/definitions\/headerData"
},
"subsidiaries": {
"type": "array",
"items": {
"$ref": "#\/definitions\/resSubsidiaries"
}
},
"links": {
"$ref": "#\/definitions\/topLevelLinks"
}
},
"additionalProperties": false
}
{
"properties": {
"subsidiaryNit": {
"type": "string",
"description": "Número de identificación tributario de la filial (NIT) con dígito de verificación.",
"example": "800987678",
"maxLength": 11,
"minLength": 11
},
"subsidiaryName": {
"type": "string",
"description": "Nombre de la filial.",
"example": "Bancolombia Panamá",
"maxLength": 80,
"minLength": 3
},
"productAttachable": {
"type": "boolean",
"description": "Campo que retorna verdadero si el cliente tiene al menos un producto embargable en la filial.",
"example": "true"
}
},
"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": "2019-08-26T05: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": "Customers"
},
"id": {
"type": "string",
"example": "Customer-2019-08-26T05: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
}