Esta API valida si la cuenta de depósito de un cliente Bancolombia permite el abono automático.
- Protocols: HTTPS
Base Gateway API Endpoint
Paths
/actions/validate-automatic-credit
Esta capacidad verifica si una cuenta permite el abono automático.
Esta capacidad verifica si la cuenta de depósito de un cliente Bancolombia permite el abono automático.
Proveedor de OAuth para autenticación con One Time Password(OTP) para Pymes
Información de la cuenta.
application/vnd.bancolombia.v1+json
Successful response.
Error in the request.
Incorrect credentials.
You do not have permissions to access the resource.
Resource not found.
Resource state has conflicts with data of the request.
Internal server error.
Error in the service provider response.
Service unavailable.
Service provider response time exceeded.
Unexpected Error.
Validar si una cuenta está inscrita al servicio abono automático.
Esta operación valida si una cuenta se encuentra inscrita al servicio de abono automático.
Proveedor de OAuth para autenticación con One Time Password(OTP) para Pymes
Respuesta exitosa.
Definitions
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"account_type",
"account_number"
],
"properties": {
"account_type": {
"type": "string",
"description": "Tipo de la cuenta a la cual se le va a hacer el abono automático.",
"example": "AHORROS",
"maxLength": 10,
"minLength": 1,
"enum": [
"AHORROS",
"CORRIENTE"
]
},
"account_number": {
"type": "string",
"description": "Número de la cuenta a la cual se le va a hacer el abono automático.",
"example": "12345678901",
"maxLength": 11,
"minLength": 1
}
}
}
}
}
}
{
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#\/definitions\/meta"
},
"data": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"required": [
"header",
"account"
],
"properties": {
"header": {
"$ref": "#\/definitions\/headerData"
},
"account": {
"$ref": "#\/definitions\/account"
}
}
}
},
"links": {
"$ref": "#\/definitions\/topLevelLinks"
}
},
"additionalProperties": false
}
{
"type": "object",
"required": [
"account_automaticCredit"
],
"properties": {
"account_automaticCredit": {
"type": "boolean",
"description": "Campo que indicada si la cuenta permite abono automático.",
"example": "true"
}
}
}
Metainformació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"
}
},
"additionalProperties": true
}
El "type" y "id" para cada dato.
{
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "AccountAutomaticCredit"
},
"id": {
"type": "string",
"example": "AccountAutomaticCredit-12345678901"
}
},
"additionalProperties": false
}
URLs relacionadas con los datos primarios.
{
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/links"
}
]
}
Un objeto de recurso MAY que contiene referencias a otro objeto de recurso.
{
"type": "object",
"properties": {
"self": {
"description": "A self member, whose value is a URL for the relationship data",
"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"
}
},
"additionalProperties": false
}