API de creditar.io
API Endpoint
staging.creditar.ioLa API de creditar.io esta organizada usando REST.
JSON API
La API de creditar.io solo responde a JSON, los estándares utilizados son JSON-API y HATEOAS, a menos de que la documentación indique lo contrario.
Autenticación
La autenticación utilizada es basada en tokens. Tienes que incluir tu llave privada en todas las peticiones realizadas, utilizando el header de Authorization.
Puedes obtener tu llave privada y cambiarl en tu Panel de Administración
Tu llave privada es solo para ti, mantenla segura. No la compartas publicamente, ni la registres en tu sistema de Control de Versiones.
Todas las peticiones deben ser hechas mediante HTTPS, he aquí un ejemplo de una petición válida:
$ curl staging.creditar.io/products \
-H "Authorization: Token token=your-api-key" \
-H "Accept: application/vnd.creditar.v1+json" \
-H "Content-Type: application/json"
Headers
Tal y como se observa en el ejemplo anterior hay 3 headers de carácter obligatorio en todas las peticiones a realizar en la API de creditar.io
-
Authorization
Authorization: Token token=your-api-key -
Accept
Accept: application/vnd.creditar.v1+jsonó
Accept: application/json -
Content-Type (peticiones diferentes a GET)
Content-Type: application/json
La API de creditar.io responderá con un código 401 si no se envía el header de Authorization
Sandbox
Para habilitar en modo entorno de pruebas es obligatorio agregar el siguiente header en la petición a realizar en la API de creditar.io
-
Application-Context
Application-Context: sandbox
Productos ¶
Un Producto es la representación de un Producto de Crédito. Todas las operaciones sobre Productos son de solo lectura.
Productos ¶
Esta ruta solo listará los Productos activos.
GET staging.creditar.io/products?cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"short_name": "un-pago",
"name": "Crédito a un sólo pago",
"interest_rate": 20,
"interest_rate_days": 360,
"tax": 16,
"description": "Crédito a sólo pago...",
"payment_periodicity_label": "Mensual",
"payment_periodicity_value": 30,
"default_amount_cents": 500000,
"minimum_amount_cents": 200000,
"maximum_amount_cents": 700000,
"installments_number": 1,
"installments_minimum": 1,
"installments_maximum": 3,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"payment_days": 20
}
],
"pagination": {
"cursors": {
"after": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"next_uri": "/products?cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8"
}
},
"links": [
{
"rel": "self",
"uri": "/products"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
},
"short_name": {
"type": "string",
"description": "Nombre corto del Producto"
},
"name": {
"type": "string",
"description": "Nombre completo del Producto"
},
"interest_rate": {
"type": "number",
"description": "Cantidad en porcentaje del Interés del Producto"
},
"interest_rate_days": {
"type": "number",
"description": "Número de Días de tasa de interés del Producto"
},
"tax": {
"type": "number",
"description": "IVA del Producto"
},
"description": {
"type": "string",
"description": "Descripción del Producto"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catalogo de Periodicidad de Pago del Producto"
},
"payment_periodicity_value": {
"type": "number",
"description": "Número de la Periodicidad de Pago del Producto"
},
"default_amount_cents": {
"type": "number",
"description": "Cantidad default en centavos del Crédito del Producto"
},
"minimum_amount_cents": {
"type": "number",
"description": "Cantidad mínima en centavos del Crédito del Producto"
},
"maximum_amount_cents": {
"type": "number",
"description": "Cantidad máxima en centavos del Crédito del Producto"
},
"installments_number": {
"type": "number",
"description": "Número de Plazos del Producto"
},
"installments_minimum": {
"type": "number",
"description": "Número mínimo de Plazos del Producto"
},
"installments_maximum": {
"type": "number",
"description": "Número máximo de Plazos del Producto"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Producto"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Producto"
},
"payment_days": {
"type": "number",
"description": "Número de días para pagar después de la fecha de corte"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"payment_periodicity_label",
"payment_periodicity_value",
"default_amount_cents",
"minimum_amount_cents",
"maximum_amount_cents",
"installments_number",
"installments_minimum",
"installments_maximum",
"created_at",
"updated_at"
]
},
"description": "Productos."
},
"pagination": {
"type": "object",
"properties": {
"cursors": {
"type": "object",
"properties": {
"after": {
"type": "string",
"description": "Cursor al siguiente registro."
},
"next_uri": {
"type": "string",
"description": "URL para la siguiente página."
}
},
"required": [
"after",
"next_uri"
],
"description": "Cursores"
}
},
"required": [
"cursors"
],
"description": "Información sobre la Paginación"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias."
}
},
"required": [
"data",
"pagination",
"links"
]
}Listar todos los ProductosGET/products{?cursor}
La obtención de la lista de Productos activos es una acción paginada. Se puede pasar el parámetro opcional cursor para obtener la siguiente página de Productos. Esta ruta siempre regresará 20 Productos por página.
URI Parameters
- cursor
string(optional) Example: 5a36f715-1815-453e-81c5-68d0d1f96bc8Referencia del Cursor utilizado para paginar.
Producto ¶
Obtiene un solo Producto y todos sus detalles.
GET staging.creditar.io/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"short_name": "un-pago",
"name": "Crédito a un sólo pago",
"interest_rate": 20,
"interest_rate_days": 360,
"tax": 16,
"description": "Crédito a sólo pago...",
"payment_periodicity_label": "Mensual",
"payment_periodicity_value": 30,
"default_amount_cents": 500000,
"minimum_amount_cents": 200000,
"maximum_amount_cents": 700000,
"installments_number": 1,
"installments_minimum": 1,
"installments_maximum": 3,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"payment_days": 20
}
],
"links": [
{
"rel": "self",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
},
"short_name": {
"type": "string",
"description": "Nombre corto del Producto"
},
"name": {
"type": "string",
"description": "Nombre completo del Producto"
},
"interest_rate": {
"type": "number",
"description": "Cantidad en porcentaje del Interés del Producto"
},
"interest_rate_days": {
"type": "number",
"description": "Número de Días de tasa de interés del Producto"
},
"tax": {
"type": "number",
"description": "IVA del Producto"
},
"description": {
"type": "string",
"description": "Descripción del Producto"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catalogo de Periodicidad de Pago del Producto"
},
"payment_periodicity_value": {
"type": "number",
"description": "Número de la Periodicidad de Pago del Producto"
},
"default_amount_cents": {
"type": "number",
"description": "Cantidad default en centavos del Crédito del Producto"
},
"minimum_amount_cents": {
"type": "number",
"description": "Cantidad mínima en centavos del Crédito del Producto"
},
"maximum_amount_cents": {
"type": "number",
"description": "Cantidad máxima en centavos del Crédito del Producto"
},
"installments_number": {
"type": "number",
"description": "Número de Plazos del Producto"
},
"installments_minimum": {
"type": "number",
"description": "Número mínimo de Plazos del Producto"
},
"installments_maximum": {
"type": "number",
"description": "Número máximo de Plazos del Producto"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Producto"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Producto"
},
"payment_days": {
"type": "number",
"description": "Número de días para pagar después de la fecha de corte"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"payment_periodicity_label",
"payment_periodicity_value",
"default_amount_cents",
"minimum_amount_cents",
"maximum_amount_cents",
"installments_number",
"installments_minimum",
"installments_maximum",
"created_at",
"updated_at"
]
},
"description": "Productos."
},
"links": {
"type": "array",
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe.",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Obtener un ProductoGET/products/{id}
URI Parameters
- id
string(required) Example: 6313ac69-dc0d-45a8-8804-4ac451e1db5ciddel Producto a obtener
Estimaciones de Crédito ¶
Estimación ¶
Obtiene la Cantidad Total del Interés a pagar, así como el Total del Crédito a pagar, en base al Producto, a la Cantidad Solicitada y el Número de Plazos.
GET staging.creditar.io/credit_estimates?product_id=6313ac69-dc0d-45a8-8804-4ac451e1db5c&amount_cents=1000000&installments_number=12
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"total_interest_amount_cents": 100000,
"total_interest_tax_amount_cents": 16000,
"total_credit_amount_cents": 1116000,
"installment_plan": [
{
"number": 1,
"total_payment": 858.33,
"principal": 833.33,
"interest": 25,
"interest_tax": 4,
"ending_balance": 9166.67
},
{
"number": 2,
"total_payment": 858.33,
"principal": 833.33,
"interest": 25,
"interest_tax": 4,
"ending_balance": 8333.34
},
{
"number": 3,
"total_payment": 858.33,
"principal": 833.33,
"interest": 25,
"interest_tax": 4,
"ending_balance": 7500.01
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/credit_estimates?product_id=6313ac69-dc0d-45a8-8804-4ac451e1db5c&amount_cents=1000000&installments_number=12"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"total_interest_amount_cents": {
"type": "number",
"description": "Total a pagar de Interés en centavos"
},
"total_interest_tax_amount_cents": {
"type": "number",
"description": "Total del IVA del Interés en centavos"
},
"total_credit_amount_cents": {
"type": "number",
"description": "Total a pagar del Crédito en centavos"
},
"installment_plan": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"number": {
"type": "number"
},
"total_payment": {
"type": "number"
},
"principal": {
"type": "number"
},
"interest": {
"type": "number"
},
"interest_tax": {
"type": "number"
},
"ending_balance": {
"type": "number"
}
},
"required": [
"number",
"total_payment",
"principal",
"interest",
"interest_tax",
"ending_balance"
]
},
{
"type": "object",
"properties": {
"number": {
"type": "number"
},
"total_payment": {
"type": "number"
},
"principal": {
"type": "number"
},
"interest": {
"type": "number"
},
"interest_tax": {
"type": "number"
},
"ending_balance": {
"type": "number"
}
},
"required": [
"number",
"total_payment",
"principal",
"interest",
"interest_tax",
"ending_balance"
]
},
{
"type": "object",
"properties": {
"number": {
"type": "number"
},
"total_payment": {
"type": "number"
},
"principal": {
"type": "number"
},
"interest": {
"type": "number"
},
"interest_tax": {
"type": "number"
},
"ending_balance": {
"type": "number"
}
},
"required": [
"number",
"total_payment",
"principal",
"interest",
"interest_tax",
"ending_balance"
]
}
],
"description": "Tabla de Amortización"
}
},
"required": [
"total_interest_amount_cents",
"total_interest_tax_amount_cents",
"total_credit_amount_cents",
"installment_plan"
]
},
"description": "Estimación"
},
"links": {
"type": "array",
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe.",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "missing_parameters",
"code": "ERR-001",
"message": "Descripción del error",
"href": "staging.creditar.io/api/documentation#err-001"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Obtener una EstimaciónGET/credit_estimates{?product_id,amount_cents,installments_number}
URI Parameters
- product_id
string(required) Example: 6313ac69-dc0d-45a8-8804-4ac451e1db5ciddel Producto a obtener- amount_cents
number(required) Example: 1000000Cantidad Solicitada en centavos
- installments_number
number(required) Example: 12Número de Plazos para pagar el crédito
Clientes ¶
Cliente es una representación de un Cliente.
Clientes ¶
Esta ruta regresará una lista de Clientes.
GET staging.creditar.io/customers?cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"email": "customer@mail.com",
"first_name": "Juán",
"second_name": "Carlos",
"last_name": "Pérez",
"mother_name": "García",
"date_of_birth": "1980-03-24",
"rfc": "PEGJ800324TR4",
"curp": "PEGJ800324UT3UDHETL-7",
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"blocked": false,
"created_at": "2018-05-02",
"updated_at": "2018-05-02"
}
],
"pagination": {
"cursors": {
"after": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"next_uri": "/customers?cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8"
}
},
"links": [
{
"rel": "self",
"uri": "/customers"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email del Cliente"
},
"first_name": {
"type": "string",
"description": "Primer Nombre del Cliente"
},
"second_name": {
"type": "string",
"description": "Segundo Nombre del Cliente"
},
"last_name": {
"type": "string",
"description": "Apellido Paterno del Cliente"
},
"mother_name": {
"type": "string",
"description": "Apellido Materno del Cliente"
},
"date_of_birth": {
"type": "string",
"description": "Fecha de Nacimiento del Cliente con formato `yyyy-mm-dd`"
},
"rfc": {
"type": "string",
"description": "RFC del Cliente"
},
"curp": {
"type": "string",
"description": "CURP del Cliente"
},
"id": {
"type": "string",
"description": "ID único del Cliente"
},
"blocked": {
"type": "boolean",
"description": "Estado del Bloqueo del Cliente"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Cliente"
},
"updated_at": {
"type": "string",
"description": "Última modificación al Cliente"
}
},
"required": [
"email",
"id",
"blocked",
"created_at",
"updated_at"
]
},
"description": "Clientes"
},
"pagination": {
"type": "object",
"properties": {
"cursors": {
"type": "object",
"properties": {
"after": {
"type": "string",
"description": "Cursor al siguiente registro"
},
"next_uri": {
"type": "string",
"description": "URL para la siguiente página"
}
},
"required": [
"after",
"next_uri"
],
"description": "Cursores"
}
},
"required": [
"cursors"
],
"description": "Información sobre la Paginación"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias."
}
},
"required": [
"data",
"pagination",
"links"
]
}Listar todos los ClientesGET/customers{?cursor}
La obtención de la lista de Clientes es una acción paginada. Se puede pasar el parámetro opcional cursor para obtener la siguiente página de Clientes. Esta ruta siempre regresará 20 Clientes por página.
URI Parameters
- cursor
string(optional) Example: 5a36f715-1815-453e-81c5-68d0d1f96bc8Referencia del Cursor utilizado para paginar.
POST staging.creditar.io/customers
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"email": "customer@mail.com",
"first_name": "Juán",
"second_name": "Carlos",
"last_name": "Pérez",
"mother_name": "García",
"date_of_birth": "1980-03-24",
"rfc": "PEGJ800324TR4",
"curp": "PEGJ800324UT3UDHETL-7"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email del Cliente"
},
"first_name": {
"type": "string",
"description": "Primer Nombre del Cliente"
},
"second_name": {
"type": "string",
"description": "Segundo Nombre del Cliente"
},
"last_name": {
"type": "string",
"description": "Apellido Paterno del Cliente"
},
"mother_name": {
"type": "string",
"description": "Apellido Materno del Cliente"
},
"date_of_birth": {
"type": "string",
"description": "Fecha de Nacimiento del Cliente con formato `yyyy-mm-dd`"
},
"rfc": {
"type": "string",
"description": "RFC del Cliente"
},
"curp": {
"type": "string",
"description": "CURP del Cliente"
}
},
"required": [
"email"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"email": "customer@mail.com",
"first_name": "Juán",
"second_name": "Carlos",
"last_name": "Pérez",
"mother_name": "García",
"date_of_birth": "1980-03-24",
"rfc": "PEGJ800324TR4",
"curp": "PEGJ800324UT3UDHETL-7",
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"blocked": false,
"created_at": "2018-05-02",
"updated_at": "2018-05-02"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email del Cliente"
},
"first_name": {
"type": "string",
"description": "Primer Nombre del Cliente"
},
"second_name": {
"type": "string",
"description": "Segundo Nombre del Cliente"
},
"last_name": {
"type": "string",
"description": "Apellido Paterno del Cliente"
},
"mother_name": {
"type": "string",
"description": "Apellido Materno del Cliente"
},
"date_of_birth": {
"type": "string",
"description": "Fecha de Nacimiento del Cliente con formato `yyyy-mm-dd`"
},
"rfc": {
"type": "string",
"description": "RFC del Cliente"
},
"curp": {
"type": "string",
"description": "CURP del Cliente"
},
"id": {
"type": "string",
"description": "ID único del Cliente"
},
"blocked": {
"type": "boolean",
"description": "Estado del Bloqueo del Cliente"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Cliente"
},
"updated_at": {
"type": "string",
"description": "Última modificación al Cliente"
}
},
"required": [
"email",
"id",
"blocked",
"created_at",
"updated_at"
]
},
"description": "Clientes"
}
},
"required": [
"data"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "invalid",
"code": "ERR-100",
"message": "El email proporcionado no es válido",
"href": "staging.creditar.io/api/documentation#err-100"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Crear un ClientePOST/customers
Crea un nuevo Cliente. Recibe un objeto de JSON con los parámetros de un Cliente.
Cliente ¶
GET staging.creditar.io/customers/6315ac69-dc0d-45a8-8804-4ac451e1db5c?include=credit_application,product
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"email": "customer@mail.com",
"first_name": "Juán",
"second_name": "Carlos",
"last_name": "Pérez",
"mother_name": "García",
"date_of_birth": "1980-03-24",
"rfc": "PEGJ800324TR4",
"curp": "PEGJ800324UT3UDHETL-7",
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"blocked": false,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"credit_applications": [
{
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40"
}
],
"attachments": [
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/customers/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
{
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"rel": "application",
"uri": "/applications/636264b1-77a2-45ef-b643-e44cfbc84d40"
},
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e",
"rel": "attachment",
"uri": "/attachments/aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email del Cliente"
},
"first_name": {
"type": "string",
"description": "Primer Nombre del Cliente"
},
"second_name": {
"type": "string",
"description": "Segundo Nombre del Cliente"
},
"last_name": {
"type": "string",
"description": "Apellido Paterno del Cliente"
},
"mother_name": {
"type": "string",
"description": "Apellido Materno del Cliente"
},
"date_of_birth": {
"type": "string",
"description": "Fecha de Nacimiento del Cliente con formato `yyyy-mm-dd`"
},
"rfc": {
"type": "string",
"description": "RFC del Cliente"
},
"curp": {
"type": "string",
"description": "CURP del Cliente"
},
"id": {
"type": "string",
"description": "ID único del Cliente"
},
"blocked": {
"type": "boolean",
"description": "Estado del Bloqueo del Cliente"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Cliente"
},
"updated_at": {
"type": "string",
"description": "Última modificación al Cliente"
},
"credit_applications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
}
},
"required": [
"id"
]
},
"description": "Solicitudes de Crédito"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Archivo"
}
},
"required": [
"id"
]
},
"description": "Archivos"
}
},
"required": [
"email",
"id",
"blocked",
"created_at",
"updated_at",
"credit_applications",
"attachments"
]
},
"description": "Clientes"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe.",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"email": "customer@mail.com",
"first_name": "Juán",
"second_name": "Carlos",
"last_name": "Pérez",
"mother_name": "García",
"date_of_birth": "1980-03-24",
"rfc": "PEGJ800324TR4",
"curp": "PEGJ800324UT3UDHETL-7",
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"blocked": false,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"attachments": [
{
"attachment_type": "INE",
"url": "http://creditario.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--19f8c22c36866305fa3878fe3a04e19a0fc6f4d1/WhatsApp%20Image%202018-03-06%20at%208.24.22%20PM.pdf\"",
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"created_at": "2018-07-02"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email del Cliente"
},
"first_name": {
"type": "string",
"description": "Primer Nombre del Cliente"
},
"second_name": {
"type": "string",
"description": "Segundo Nombre del Cliente"
},
"last_name": {
"type": "string",
"description": "Apellido Paterno del Cliente"
},
"mother_name": {
"type": "string",
"description": "Apellido Materno del Cliente"
},
"date_of_birth": {
"type": "string",
"description": "Fecha de Nacimiento del Cliente con formato `yyyy-mm-dd`"
},
"rfc": {
"type": "string",
"description": "RFC del Cliente"
},
"curp": {
"type": "string",
"description": "CURP del Cliente"
},
"id": {
"type": "string",
"description": "ID único del Cliente"
},
"blocked": {
"type": "boolean",
"description": "Estado del Bloqueo del Cliente"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Cliente"
},
"updated_at": {
"type": "string",
"description": "Última modificación al Cliente"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attachment_type": {
"type": "string",
"description": "Tipo de documento del Archivo"
},
"url": {
"type": "string",
"description": "URL del Archivo"
},
"id": {
"type": "string",
"description": "ID único del Archivo"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Archivo"
}
},
"required": [
"attachment_type",
"url",
"id",
"created_at"
]
},
"description": "Archivos"
}
},
"required": [
"email",
"id",
"blocked",
"created_at",
"updated_at",
"attachments"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"email": "customer@mail.com",
"first_name": "Juán",
"second_name": "Carlos",
"last_name": "Pérez",
"mother_name": "García",
"date_of_birth": "1980-03-24",
"rfc": "PEGJ800324TR4",
"curp": "PEGJ800324UT3UDHETL-7",
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"blocked": false,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"credit_applications": [
{
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"flow": "inicio",
"state": "aprobada",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
}
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/customers/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
{
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"rel": "application",
"uri": "/applications/636264b1-77a2-45ef-b643-e44cfbc84d40"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email del Cliente"
},
"first_name": {
"type": "string",
"description": "Primer Nombre del Cliente"
},
"second_name": {
"type": "string",
"description": "Segundo Nombre del Cliente"
},
"last_name": {
"type": "string",
"description": "Apellido Paterno del Cliente"
},
"mother_name": {
"type": "string",
"description": "Apellido Materno del Cliente"
},
"date_of_birth": {
"type": "string",
"description": "Fecha de Nacimiento del Cliente con formato `yyyy-mm-dd`"
},
"rfc": {
"type": "string",
"description": "RFC del Cliente"
},
"curp": {
"type": "string",
"description": "CURP del Cliente"
},
"id": {
"type": "string",
"description": "ID único del Cliente"
},
"blocked": {
"type": "boolean",
"description": "Estado del Bloqueo del Cliente"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Cliente"
},
"updated_at": {
"type": "string",
"description": "Última modificación al Cliente"
},
"credit_applications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
}
},
"required": [
"id",
"application_number",
"created_at",
"updated_at",
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id"
]
},
"description": "Solicitudes de Crédito"
}
},
"required": [
"email",
"id",
"blocked",
"created_at",
"updated_at",
"credit_applications"
]
},
"description": "Clientes"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"email": "customer@mail.com",
"first_name": "Juán",
"second_name": "Carlos",
"last_name": "Pérez",
"mother_name": "García",
"date_of_birth": "1980-03-24",
"rfc": "PEGJ800324TR4",
"curp": "PEGJ800324UT3UDHETL-7",
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"blocked": false,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"credit_applications": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"short_name": "un-pago",
"name": "Crédito a un sólo pago",
"interest_rate": 20,
"interest_rate_days": 360,
"tax": 16,
"description": "Crédito a sólo pago...",
"payment_periodicity_label": "Mensual",
"payment_periodicity_value": 30,
"default_amount_cents": 500000,
"minimum_amount_cents": 200000,
"maximum_amount_cents": 700000,
"installments_number": 1,
"installments_minimum": 1,
"installments_maximum": 3,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"payment_days": 20
},
"contract": {},
"incomes": [],
"expenses": [],
"references": []
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/customers/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
{
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"rel": "application",
"uri": "/applications/636264b1-77a2-45ef-b643-e44cfbc84d40"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email del Cliente"
},
"first_name": {
"type": "string",
"description": "Primer Nombre del Cliente"
},
"second_name": {
"type": "string",
"description": "Segundo Nombre del Cliente"
},
"last_name": {
"type": "string",
"description": "Apellido Paterno del Cliente"
},
"mother_name": {
"type": "string",
"description": "Apellido Materno del Cliente"
},
"date_of_birth": {
"type": "string",
"description": "Fecha de Nacimiento del Cliente con formato `yyyy-mm-dd`"
},
"rfc": {
"type": "string",
"description": "RFC del Cliente"
},
"curp": {
"type": "string",
"description": "CURP del Cliente"
},
"id": {
"type": "string",
"description": "ID único del Cliente"
},
"blocked": {
"type": "boolean",
"description": "Estado del Bloqueo del Cliente"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Cliente"
},
"updated_at": {
"type": "string",
"description": "Última modificación al Cliente"
},
"credit_applications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
},
"short_name": {
"type": "string",
"description": "Nombre corto del Producto"
},
"name": {
"type": "string",
"description": "Nombre completo del Producto"
},
"interest_rate": {
"type": "number",
"description": "Cantidad en porcentaje del Interés del Producto"
},
"interest_rate_days": {
"type": "number",
"description": "Número de Días de tasa de interés del Producto"
},
"tax": {
"type": "number",
"description": "IVA del Producto"
},
"description": {
"type": "string",
"description": "Descripción del Producto"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catalogo de Periodicidad de Pago del Producto"
},
"payment_periodicity_value": {
"type": "number",
"description": "Número de la Periodicidad de Pago del Producto"
},
"default_amount_cents": {
"type": "number",
"description": "Cantidad default en centavos del Crédito del Producto"
},
"minimum_amount_cents": {
"type": "number",
"description": "Cantidad mínima en centavos del Crédito del Producto"
},
"maximum_amount_cents": {
"type": "number",
"description": "Cantidad máxima en centavos del Crédito del Producto"
},
"installments_number": {
"type": "number",
"description": "Número de Plazos del Producto"
},
"installments_minimum": {
"type": "number",
"description": "Número mínimo de Plazos del Producto"
},
"installments_maximum": {
"type": "number",
"description": "Número máximo de Plazos del Producto"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Producto"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Producto"
},
"payment_days": {
"type": "number",
"description": "Número de días para pagar después de la fecha de corte"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"payment_periodicity_label",
"payment_periodicity_value",
"default_amount_cents",
"minimum_amount_cents",
"maximum_amount_cents",
"installments_number",
"installments_minimum",
"installments_maximum",
"created_at",
"updated_at",
"payment_days"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {},
"additionalProperties": false,
"description": "Contrato de la Solicitud"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Ingresos de la Solicitud"
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Egresos de la Solicitud"
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Referencias de la Solicitud"
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"product"
]
}
}
},
"required": [
"email",
"id",
"blocked",
"created_at",
"updated_at",
"credit_applications"
]
},
"description": "Clientes"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Obtener un ClienteGET/customers/{id}{?include}
Obtiene un solo Cliente y todos sus detalles. Cuando se utiliza el parámetro include, recursos relacionados son incluidos.
Los valores válidos para el parámetro de include son credit_application y product. Los valores deben ir serparados por coma y sin espacios.
Si se pasa credit_application, se incluirán los detalles de las Solicitudes de Crédito pero no los de Producto.
Si se pasa product, se incluirán los detalles de las Solicitudes de Crédito y de Producto.
URI Parameters
- id
string(required) Example: 6315ac69-dc0d-45a8-8804-4ac451e1db5ciddel Cliente a obtener- include
string(optional) Example: credit_application,productCadena de texto para indicar si la respuesta debe incluir recursos relacionados.
PATCH staging.creditar.io/customers/6315ac69-dc0d-45a8-8804-4ac451e1db5c?include=credit_application,product
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"email": "customer@mail.com",
"first_name": "Juán",
"second_name": "Carlos",
"last_name": "Pérez",
"mother_name": "García",
"date_of_birth": "1980-03-24",
"rfc": "PEGJ800324TR4",
"curp": "PEGJ800324UT3UDHETL-7"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email del Cliente"
},
"first_name": {
"type": "string",
"description": "Primer Nombre del Cliente"
},
"second_name": {
"type": "string",
"description": "Segundo Nombre del Cliente"
},
"last_name": {
"type": "string",
"description": "Apellido Paterno del Cliente"
},
"mother_name": {
"type": "string",
"description": "Apellido Materno del Cliente"
},
"date_of_birth": {
"type": "string",
"description": "Fecha de Nacimiento del Cliente con formato `yyyy-mm-dd`"
},
"rfc": {
"type": "string",
"description": "RFC del Cliente"
},
"curp": {
"type": "string",
"description": "CURP del Cliente"
}
},
"required": [
"email"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"email": "customer@mail.com",
"first_name": "Juán",
"second_name": "Carlos",
"last_name": "Pérez",
"mother_name": "García",
"date_of_birth": "1980-03-24",
"rfc": "PEGJ800324TR4",
"curp": "PEGJ800324UT3UDHETL-7",
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"blocked": false,
"created_at": "2018-05-02",
"updated_at": "2018-05-02"
}
],
"links": [
{
"rel": "self",
"uri": "/customers/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email del Cliente"
},
"first_name": {
"type": "string",
"description": "Primer Nombre del Cliente"
},
"second_name": {
"type": "string",
"description": "Segundo Nombre del Cliente"
},
"last_name": {
"type": "string",
"description": "Apellido Paterno del Cliente"
},
"mother_name": {
"type": "string",
"description": "Apellido Materno del Cliente"
},
"date_of_birth": {
"type": "string",
"description": "Fecha de Nacimiento del Cliente con formato `yyyy-mm-dd`"
},
"rfc": {
"type": "string",
"description": "RFC del Cliente"
},
"curp": {
"type": "string",
"description": "CURP del Cliente"
},
"id": {
"type": "string",
"description": "ID único del Cliente"
},
"blocked": {
"type": "boolean",
"description": "Estado del Bloqueo del Cliente"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Cliente"
},
"updated_at": {
"type": "string",
"description": "Última modificación al Cliente"
}
},
"required": [
"email",
"id",
"blocked",
"created_at",
"updated_at"
]
},
"description": "Clientes"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "invalid",
"code": "ERR-100",
"message": "El email proporcionado no es válido",
"href": "staging.creditar.io/api/documentation#err-100"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "blocked",
"code": "ERR-101",
"message": "El Cliente no puede estar bloqueado.",
"href": "staging.creditar.io/api/documentation#err-101"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlance para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe.",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Actualizar un ClientePATCH/customers/{id}{?include}
Actualiza un Cliente existente. Esta operación solo puede ser ejecutada en Clientes desbloqueados.
URI Parameters
- id
string(required) Example: 6315ac69-dc0d-45a8-8804-4ac451e1db5ciddel Cliente a obtener- include
string(optional) Example: credit_application,productCadena de texto para indicar si la respuesta debe incluir recursos relacionados.
Solicitudes ¶
Una Solicitud es la representación de una Solicitud de Crédito.
Solicitudes ¶
Esta ruta regresará una lista de Solicitudes de Crédito.
GET staging.creditar.io/applications?cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8&customer_id=8ab6078-fada-437a-ad6a-fb6b1e4a1e2e
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02"
}
],
"pagination": {
"cursors": {
"after": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"next_uri": "/applications?cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8"
}
},
"links": [
{
"rel": "self",
"uri": "/applications"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at"
]
},
"description": "Solicitudes de Crédito"
},
"pagination": {
"type": "object",
"properties": {
"cursors": {
"type": "object",
"properties": {
"after": {
"type": "string",
"description": "Cursor al siguiente registro"
},
"next_uri": {
"type": "string",
"description": "URL para la siguiente página"
}
},
"required": [
"after",
"next_uri"
],
"description": "Cursores"
}
},
"required": [
"cursors"
],
"description": "Información sobre la Paginación"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias."
}
},
"required": [
"data",
"pagination",
"links"
]
}Listar todas las SolicitudesGET/applications{?cursor,customer_id}
La obtención de la lista de Solicitudes es una acción paginada. Se puede pasar el parámetro opcional cursor para obtener la siguiente página de Solicitudes. Esta ruta siempre regresará 20 Solicitudes por página.
También puedes utilizar el parámetro customer_id para filtrar por Cliente.
URI Parameters
- cursor
string(optional) Example: 5a36f715-1815-453e-81c5-68d0d1f96bc8Referencia del Cursor utilizado para paginar.
- customer_id
string(optional) Example: 8ab6078-fada-437a-ad6a-fb6b1e4a1e2eiddel Cliente.
POST staging.creditar.io/applications
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"application_number": "UENDSND-1",
"flow": "Inicio",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"closing_date_at": "2020-02-12",
"payment_days": 20
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
}
},
"required": [
"product_id",
"customer_id",
"application_number",
"flow",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "",
"state": "",
"amount_cents": 0,
"installments": 0,
"approved_amount_cents": 0,
"street_address": "",
"exterior_number_address": "",
"interior_number_address": "",
"neighborhood_address": "",
"state_address": "",
"city_address": "",
"zipcode_address": "",
"home_phone": "",
"mobile_phone": "",
"classification": "",
"description": "",
"metadata": {},
"accepted_at": "",
"rejected_at": "",
"rejected_notes": "",
"approved_at": "",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"short_name": "un-pago",
"name": "Crédito a un sólo pago",
"interest_rate": 20,
"interest_rate_days": 360,
"tax": 16,
"description": "Crédito a sólo pago...",
"payment_periodicity_label": "Mensual",
"payment_periodicity_value": 30,
"default_amount_cents": 500000,
"minimum_amount_cents": 200000,
"maximum_amount_cents": 700000,
"installments_number": 1,
"installments_minimum": 1,
"installments_maximum": 3,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"payment_days": 20
},
"contract": {},
"incomes": [],
"expenses": [],
"references": []
}
],
"links": [
{
"rel": "self"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
},
"short_name": {
"type": "string",
"description": "Nombre corto del Producto"
},
"name": {
"type": "string",
"description": "Nombre completo del Producto"
},
"interest_rate": {
"type": "number",
"description": "Cantidad en porcentaje del Interés del Producto"
},
"interest_rate_days": {
"type": "number",
"description": "Número de Días de tasa de interés del Producto"
},
"tax": {
"type": "number",
"description": "IVA del Producto"
},
"description": {
"type": "string",
"description": "Descripción del Producto"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catalogo de Periodicidad de Pago del Producto"
},
"payment_periodicity_value": {
"type": "number",
"description": "Número de la Periodicidad de Pago del Producto"
},
"default_amount_cents": {
"type": "number",
"description": "Cantidad default en centavos del Crédito del Producto"
},
"minimum_amount_cents": {
"type": "number",
"description": "Cantidad mínima en centavos del Crédito del Producto"
},
"maximum_amount_cents": {
"type": "number",
"description": "Cantidad máxima en centavos del Crédito del Producto"
},
"installments_number": {
"type": "number",
"description": "Número de Plazos del Producto"
},
"installments_minimum": {
"type": "number",
"description": "Número mínimo de Plazos del Producto"
},
"installments_maximum": {
"type": "number",
"description": "Número máximo de Plazos del Producto"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Producto"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Producto"
},
"payment_days": {
"type": "number",
"description": "Número de días para pagar después de la fecha de corte"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"payment_periodicity_label",
"payment_periodicity_value",
"default_amount_cents",
"minimum_amount_cents",
"maximum_amount_cents",
"installments_number",
"installments_minimum",
"installments_maximum",
"created_at",
"updated_at",
"payment_days"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {},
"additionalProperties": false,
"description": "Contrato de la Solicitud"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Ingresos de la Solicitud"
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Egresos de la Solicitud"
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Referencias de la Solicitud"
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"product"
]
},
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
}
},
"required": [
"rel"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "inactive",
"code": "ERR-120",
"message": "El Producto debe estar activo.",
"href": "staging.creditar.io/api/documentation#err-120"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Crear una SolicitudPOST/applications
Crea una nueva Solicitud. Recibe un objeto de JSON con el product_id y customer_id.
Solicitud ¶
GET staging.creditar.io/applications/636264b1-77a2-45ef-b643-e44cfbc84d40?include=product,contract,income,expense,reference,attachment
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
"contract": {
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
"incomes": [
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
],
"expenses": [
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96"
}
],
"references": [
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
],
"attachments": [
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/applications/636264b1-77a2-45ef-b643-e44cfbc84d40"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
{
"id": "4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb",
"rel": "contract",
"uri": "/contracts/4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb"
},
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"rel": "income",
"uri": "/incomes/3c8b46ce-a5f2-4f25-8280-a80551eacd21"
},
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"rel": "expense",
"uri": "/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96"
},
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"rel": "reference",
"uri": "/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e",
"rel": "attachment",
"uri": "/attachments/aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Contrato de la Solicitud de Crédito"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Ingreso"
}
},
"required": [
"id"
]
}
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Egreso"
}
},
"required": [
"id"
]
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único de la Referencia"
}
},
"required": [
"id"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Archivo"
}
},
"required": [
"id"
]
}
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"incomes",
"expenses",
"references",
"attachments"
]
},
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"short_name": "un-pago",
"name": "Crédito a un sólo pago",
"interest_rate": 20,
"interest_rate_days": 360,
"tax": 16,
"description": "Crédito a sólo pago...",
"payment_periodicity_label": "Mensual",
"payment_periodicity_value": 30,
"default_amount_cents": 500000,
"minimum_amount_cents": 200000,
"maximum_amount_cents": 700000,
"installments_number": 1,
"installments_minimum": 1,
"installments_maximum": 3,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"payment_days": 20
},
"contract": {
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
"incomes": [
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
],
"expenses": [
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96"
}
],
"references": [
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
],
"attachments": [
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}
],
"links": [
{
"rel": "self"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
},
"short_name": {
"type": "string",
"description": "Nombre corto del Producto"
},
"name": {
"type": "string",
"description": "Nombre completo del Producto"
},
"interest_rate": {
"type": "number",
"description": "Cantidad en porcentaje del Interés del Producto"
},
"interest_rate_days": {
"type": "number",
"description": "Número de Días de tasa de interés del Producto"
},
"tax": {
"type": "number",
"description": "IVA del Producto"
},
"description": {
"type": "string",
"description": "Descripción del Producto"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catalogo de Periodicidad de Pago del Producto"
},
"payment_periodicity_value": {
"type": "number",
"description": "Número de la Periodicidad de Pago del Producto"
},
"default_amount_cents": {
"type": "number",
"description": "Cantidad default en centavos del Crédito del Producto"
},
"minimum_amount_cents": {
"type": "number",
"description": "Cantidad mínima en centavos del Crédito del Producto"
},
"maximum_amount_cents": {
"type": "number",
"description": "Cantidad máxima en centavos del Crédito del Producto"
},
"installments_number": {
"type": "number",
"description": "Número de Plazos del Producto"
},
"installments_minimum": {
"type": "number",
"description": "Número mínimo de Plazos del Producto"
},
"installments_maximum": {
"type": "number",
"description": "Número máximo de Plazos del Producto"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Producto"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Producto"
},
"payment_days": {
"type": "number",
"description": "Número de días para pagar después de la fecha de corte"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"payment_periodicity_label",
"payment_periodicity_value",
"default_amount_cents",
"minimum_amount_cents",
"maximum_amount_cents",
"installments_number",
"installments_minimum",
"installments_maximum",
"created_at",
"updated_at",
"payment_days"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Contrato de la Solicitud de Crédito"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Ingreso"
}
},
"required": [
"id"
]
}
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Egreso"
}
},
"required": [
"id"
]
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único de la Referencia"
}
},
"required": [
"id"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Archivo"
}
},
"required": [
"id"
]
}
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"product",
"incomes",
"expenses",
"references",
"attachments"
]
},
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
}
},
"required": [
"rel"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": {
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
"contract": {
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"body": "Contrato del Crédito..."
},
"incomes": [
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
],
"expenses": [
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96"
}
],
"references": [
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
],
"attachments": [
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
},
"links": [
{
"rel": "self"
},
{
"id": "4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb",
"rel": "contract",
"uri": "/contracts/4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
},
"body": {
"type": "string",
"description": "Cuerpo del Contrato"
}
},
"required": [
"id",
"body"
],
"additionalProperties": false,
"description": "Contrato de la Solicitud de Crédito"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Ingreso"
}
},
"required": [
"id"
]
}
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Egreso"
}
},
"required": [
"id"
]
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único de la Referencia"
}
},
"required": [
"id"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Archivo"
}
},
"required": [
"id"
]
}
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"closing_date_at",
"payment_days",
"id",
"application_number",
"created_at",
"updated_at",
"product",
"contract",
"incomes",
"expenses",
"references",
"attachments"
],
"additionalProperties": false,
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
}
},
"required": [
"rel"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
"contract": {
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
"incomes": [
{
"classification": "Trabajo",
"amount_cents": 450000,
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"created_at": "2018-07-02"
}
],
"expenses": [
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96"
}
],
"references": [
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
],
"attachments": [
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/applications/636264b1-77a2-45ef-b643-e44cfbc84d40"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
{
"id": "4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb",
"rel": "contract",
"uri": "/contracts/4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb"
},
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"rel": "income",
"uri": "/incomes/3c8b46ce-a5f2-4f25-8280-a80551eacd21"
},
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"rel": "expense",
"uri": "/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96"
},
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"rel": "reference",
"uri": "/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e",
"rel": "attachment",
"uri": "/attachments/aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Contrato de la Solicitud de Crédito"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Ingreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Ingreso"
},
"id": {
"type": "string",
"description": "ID único del Ingreso"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Ingreso"
}
},
"required": [
"classification",
"amount_cents",
"id",
"created_at"
]
}
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Egreso"
}
},
"required": [
"id"
]
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único de la Referencia"
}
},
"required": [
"id"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Archivo"
}
},
"required": [
"id"
]
}
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"incomes",
"expenses",
"references",
"attachments"
]
},
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
"contract": {
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
"incomes": [
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
],
"expenses": [
{
"classification": "Renta",
"amount_cents": 250000,
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"created_at": "2018-07-02"
}
],
"references": [
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
],
"attachments": [
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/applications/636264b1-77a2-45ef-b643-e44cfbc84d40"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
{
"id": "4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb",
"rel": "contract",
"uri": "/contracts/4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb"
},
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"rel": "income",
"uri": "/incomes/3c8b46ce-a5f2-4f25-8280-a80551eacd21"
},
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"rel": "expense",
"uri": "/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96"
},
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"rel": "reference",
"uri": "/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e",
"rel": "attachment",
"uri": "/attachments/aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Contrato de la Solicitud de Crédito"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Ingreso"
}
},
"required": [
"id"
]
}
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Egreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Egreso"
},
"id": {
"type": "string",
"description": "ID único del Egreso"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Egreso"
}
},
"required": [
"classification",
"amount_cents",
"id",
"created_at"
]
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único de la Referencia"
}
},
"required": [
"id"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Archivo"
}
},
"required": [
"id"
]
}
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"incomes",
"expenses",
"references",
"attachments"
]
},
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
"contract": {
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
"incomes": [
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
],
"expenses": [
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96"
}
],
"references": [
{
"classification": "Renta",
"name": "Rigoberto Villegas",
"phone": "3121159945",
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"created_at": "2018-07-02"
}
],
"attachments": [
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/applications/636264b1-77a2-45ef-b643-e44cfbc84d40"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
{
"id": "4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb",
"rel": "contract",
"uri": "/contracts/4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb"
},
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"rel": "income",
"uri": "/incomes/3c8b46ce-a5f2-4f25-8280-a80551eacd21"
},
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"rel": "expense",
"uri": "/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96"
},
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"rel": "reference",
"uri": "/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e",
"rel": "attachment",
"uri": "/attachments/aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Contrato de la Solicitud de Crédito"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Ingreso"
}
},
"required": [
"id"
]
}
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Egreso"
}
},
"required": [
"id"
]
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación de la Referencia"
},
"name": {
"type": "string",
"description": "Nombre de la Referencia"
},
"phone": {
"type": "string",
"description": "Teléfono de la Referencia"
},
"id": {
"type": "string",
"description": "ID único de la Referencia"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Egreso"
}
},
"required": [
"classification",
"name",
"phone",
"id",
"created_at"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Archivo"
}
},
"required": [
"id"
]
}
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"incomes",
"expenses",
"references",
"attachments"
]
},
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
"contract": {
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
"incomes": [
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
],
"expenses": [
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96"
}
],
"references": [
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
],
"attachments": [
{
"attachment_type": "INE",
"url": "http://creditario.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--19f8c22c36866305fa3878fe3a04e19a0fc6f4d1/WhatsApp%20Image%202018-03-06%20at%208.24.22%20PM.pdf\"",
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"created_at": "2018-07-02"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/applications/636264b1-77a2-45ef-b643-e44cfbc84d40"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
{
"id": "4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb",
"rel": "contract",
"uri": "/contracts/4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb"
},
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"rel": "income",
"uri": "/incomes/3c8b46ce-a5f2-4f25-8280-a80551eacd21"
},
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"rel": "expense",
"uri": "/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96"
},
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"rel": "reference",
"uri": "/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e",
"rel": "attachment",
"uri": "/attachments/aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Contrato de la Solicitud de Crédito"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Ingreso"
}
},
"required": [
"id"
]
}
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Egreso"
}
},
"required": [
"id"
]
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único de la Referencia"
}
},
"required": [
"id"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attachment_type": {
"type": "string",
"description": "Tipo de documento del Archivo"
},
"url": {
"type": "string",
"description": "URL del Archivo"
},
"id": {
"type": "string",
"description": "ID único del Archivo"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Archivo"
}
},
"required": [
"attachment_type",
"url",
"id",
"created_at"
]
}
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"incomes",
"expenses",
"references",
"attachments"
]
},
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"short_name": "un-pago",
"name": "Crédito a un sólo pago",
"interest_rate": 20,
"interest_rate_days": 360,
"tax": 16,
"description": "Crédito a sólo pago...",
"payment_periodicity_label": "Mensual",
"payment_periodicity_value": 30,
"default_amount_cents": 500000,
"minimum_amount_cents": 200000,
"maximum_amount_cents": 700000,
"installments_number": 1,
"installments_minimum": 1,
"installments_maximum": 3,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"payment_days": 20
},
"contract": {
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"body": "Contrato del Crédito..."
},
"incomes": [
{
"classification": "Trabajo",
"amount_cents": 450000,
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"created_at": "2018-07-02"
}
],
"expenses": [
{
"classification": "Renta",
"amount_cents": 250000,
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"created_at": "2018-07-02"
}
],
"references": [
{
"classification": "Renta",
"name": "Rigoberto Villegas",
"phone": "3121159945",
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"created_at": "2018-07-02"
}
],
"attachments": [
{
"attachment_type": "INE",
"url": "http://creditario.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--19f8c22c36866305fa3878fe3a04e19a0fc6f4d1/WhatsApp%20Image%202018-03-06%20at%208.24.22%20PM.pdf\"",
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"created_at": "2018-07-02"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/applications/636264b1-77a2-45ef-b643-e44cfbc84d40"
},
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"rel": "product",
"uri": "/products/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
{
"id": "4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb",
"rel": "contract",
"uri": "/contracts/4e9ece5f-d4e6-4fcd-bc9b-b437bef23ceb"
},
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"rel": "income",
"uri": "/incomes/3c8b46ce-a5f2-4f25-8280-a80551eacd21"
},
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"rel": "expense",
"uri": "/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96"
},
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"rel": "reference",
"uri": "/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e",
"rel": "attachment",
"uri": "/attachments/aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
},
"short_name": {
"type": "string",
"description": "Nombre corto del Producto"
},
"name": {
"type": "string",
"description": "Nombre completo del Producto"
},
"interest_rate": {
"type": "number",
"description": "Cantidad en porcentaje del Interés del Producto"
},
"interest_rate_days": {
"type": "number",
"description": "Número de Días de tasa de interés del Producto"
},
"tax": {
"type": "number",
"description": "IVA del Producto"
},
"description": {
"type": "string",
"description": "Descripción del Producto"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catalogo de Periodicidad de Pago del Producto"
},
"payment_periodicity_value": {
"type": "number",
"description": "Número de la Periodicidad de Pago del Producto"
},
"default_amount_cents": {
"type": "number",
"description": "Cantidad default en centavos del Crédito del Producto"
},
"minimum_amount_cents": {
"type": "number",
"description": "Cantidad mínima en centavos del Crédito del Producto"
},
"maximum_amount_cents": {
"type": "number",
"description": "Cantidad máxima en centavos del Crédito del Producto"
},
"installments_number": {
"type": "number",
"description": "Número de Plazos del Producto"
},
"installments_minimum": {
"type": "number",
"description": "Número mínimo de Plazos del Producto"
},
"installments_maximum": {
"type": "number",
"description": "Número máximo de Plazos del Producto"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Producto"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Producto"
},
"payment_days": {
"type": "number",
"description": "Número de días para pagar después de la fecha de corte"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"payment_periodicity_label",
"payment_periodicity_value",
"default_amount_cents",
"minimum_amount_cents",
"maximum_amount_cents",
"installments_number",
"installments_minimum",
"installments_maximum",
"created_at",
"updated_at",
"payment_days"
],
"additionalProperties": false
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
},
"body": {
"type": "string",
"description": "Cuerpo del Contrato"
}
},
"required": [
"id",
"body"
],
"additionalProperties": false
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Ingreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Ingreso"
},
"id": {
"type": "string",
"description": "ID único del Ingreso"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Ingreso"
}
},
"required": [
"classification",
"amount_cents",
"id",
"created_at"
]
}
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Egreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Egreso"
},
"id": {
"type": "string",
"description": "ID único del Egreso"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Egreso"
}
},
"required": [
"classification",
"amount_cents",
"id",
"created_at"
]
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación de la Referencia"
},
"name": {
"type": "string",
"description": "Nombre de la Referencia"
},
"phone": {
"type": "string",
"description": "Teléfono de la Referencia"
},
"id": {
"type": "string",
"description": "ID único de la Referencia"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Egreso"
}
},
"required": [
"classification",
"name",
"phone",
"id",
"created_at"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attachment_type": {
"type": "string",
"description": "Tipo de documento del Archivo"
},
"url": {
"type": "string",
"description": "URL del Archivo"
},
"id": {
"type": "string",
"description": "ID único del Archivo"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Archivo"
}
},
"required": [
"attachment_type",
"url",
"id",
"created_at"
]
}
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"product",
"contract",
"incomes",
"expenses",
"references",
"attachments"
]
},
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"id",
"rel",
"uri"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Obtener una SolicitudGET/applications/{id}{?include}
Obtiene una sola Solicitud y todos sus detalles. Cuando se utiliza el parámetro include, recursos relacionados son incluidos.
Los valores válidos para el parámetro de include son income, expense, reference y attachment. Los valores deben ir separados por coma y sin espacios.
Para el atributo estado state los valores que se esperan recibir de una Solicitud son los siguientes:
-
en_tramite- Se encuentra en trámite sin datos y lista para completarla. -
en_calificacion- Se encuentra en calificación. Ha sido calificada por un Flujo de Calificación desde el Dashboard. -
rechazada- Se encuentra rechazada. Para que sea rechazada es necesario actualizar los atributos Notas del rechazorejected_notespor un texto del motivo del rechazo y Fecha de Rechazorejected_atpor una fecha con formato2019-02-12. Nota: Una Solicitud puede ser rechazada si se encuentra en trámite, calificacíon ó aprobada. -
aprobada- Se encuentra aprobada. Para que sea aprobada es necesario actualizar los atributos Monto aprobadoapproved_amount_centspor una cantidad en centavos, Fecha de aprobaciónapproved_atpor una fecha con formato2019-02-14ó el atributo CLABEclabepara definir la clabe interbancaria. Nota: Para que pueda ser aprobada es necesario que haya pasado y cumplido con el Flujo de Calificación. -
aceptada- Se encuentra aceptada. Para que sea aceptada es necesario actualizar los atributos Fecha de pago inicialfirst_payment_datepor una fecha con formato2019-03-24y Fecha de aceptaciónaccepted_atpor una fecha con formato2019-04-12. Nota: Una Solicitud puede ser aceptada si se encuentra aprobada. -
en_credito- Se encuentra en Crédito.
URI Parameters
- id
string(required) Example: 636264b1-77a2-45ef-b643-e44cfbc84d40idde la Solicitud de Crédito a obtener- include
string(optional) Example: product,contract,income,expense,reference,attachmentCadena de texto para indicar si la respuesta debe incluir recursos relacionados.
PATCH staging.creditar.io/applications/636264b1-77a2-45ef-b643-e44cfbc84d40?include=product,contract,income,expense,reference,attachment
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"application_number": "UENDSND-1",
"flow": "Inicio",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"closing_date_at": "2020-02-12",
"payment_days": 20
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
}
},
"required": [
"product_id",
"customer_id",
"application_number",
"flow",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"flow": "inicio",
"state": "en_tramite",
"amount_cents": 500000,
"installments": 12,
"approved_amount_cents": 0,
"street_address": "Av. Carranza",
"exterior_number_address": "1248",
"interior_number_address": "",
"neighborhood_address": "Colinas de Santa Bárbara",
"state_address": "Colima",
"city_address": "Villa de Álvarez",
"zipcode_address": "28017",
"home_phone": "3121225627",
"mobile_phone": "3123452287",
"classification": "Pagar deudas",
"description": "Necesito consolidar deudas con un mejor interés",
"metadata": {},
"accepted_at": "2018-05-01",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"clabe": "002115016003269411",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"closing_date_at": "2020-02-12",
"payment_days": 20,
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"product": {
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c"
},
"contract": {
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
},
"incomes": [
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
],
"expenses": [
{
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96"
}
],
"references": [
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
],
"attachments": [
{
"id": "aabfd43d-6f63-44dd-b7d9-9352a101d11e"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/applications/6313ac69-dc0d-45a8-8804-4ac451e1db5c"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"flow": {
"type": "string",
"description": "Paso actual del flujo de la Solicitud de Crédito"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"amount_cents": {
"type": "number",
"description": "Total del Crédito Solicitado"
},
"installments": {
"type": "number",
"description": "Número de Plazos de la Solicitud de Crédito."
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"street_address": {
"type": "string",
"description": "Calle"
},
"exterior_number_address": {
"type": "string",
"description": "Número exterior"
},
"interior_number_address": {
"type": "string",
"description": "Número interior"
},
"neighborhood_address": {
"type": "string",
"description": "Colonia"
},
"state_address": {
"type": "string",
"description": "Estado"
},
"city_address": {
"type": "string",
"description": "Ciudad"
},
"zipcode_address": {
"type": "string",
"description": "Código Postal"
},
"home_phone": {
"type": "string",
"description": "Teléfono de Casa"
},
"mobile_phone": {
"type": "string",
"description": "Mobile phone."
},
"classification": {
"type": "string",
"description": "Clasificación de la Solicitud de Crédito"
},
"description": {
"type": "string",
"description": "Descripción de la Solicitud de Crédito"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales de la Solicitud de Crédito"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"rejected_at": {
"type": "string",
"description": "Fecha de Rechazo"
},
"rejected_notes": {
"type": "string",
"description": "Notas del Rechazo"
},
"approved_at": {
"type": "string",
"description": "Fecha de Aprobación"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"closing_date_at": {
"type": [
"string",
"null"
],
"description": "Fecha de corte de la Solicitud de Crédito"
},
"payment_days": {
"type": [
"number",
"null"
],
"description": "Días de pago de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"id": {
"type": "string",
"description": "ID único de la Solicitud de Crédito"
},
"application_number": {
"type": "string",
"description": "Número de la Solicitud de Crédito"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Solicitud de Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Solicitud de Crédito"
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Producto"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Producto de la Solicitud de Crédito"
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Contrato de la Solicitud de Crédito"
},
"incomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Ingreso"
}
},
"required": [
"id"
]
}
},
"expenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Egreso"
}
},
"required": [
"id"
]
}
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único de la Referencia"
}
},
"required": [
"id"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Archivo"
}
},
"required": [
"id"
]
}
}
},
"required": [
"flow",
"state",
"amount_cents",
"installments",
"approved_amount_cents",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"accepted_at",
"rejected_at",
"rejected_notes",
"approved_at",
"clabe",
"customer_id",
"id",
"application_number",
"created_at",
"updated_at",
"incomes",
"expenses",
"references",
"attachments"
]
},
"description": "Solicitudes de Crédito"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_a_number",
"code": "ERR-130",
"message": "La cantidad del crédito debe ser un número de centavos.",
"href": "staging.creditar.io/api/documentation#err-130"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe.",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Actualizar una SolicitudPATCH/applications/{id}{?include}
Actualiza una Solicitud existente.
URI Parameters
- id
string(required) Example: 636264b1-77a2-45ef-b643-e44cfbc84d40idde la Solicitud de Crédito a obtener- include
string(optional) Example: product,contract,income,expense,reference,attachmentCadena de texto para indicar si la respuesta debe incluir recursos relacionados.
Contratos ¶
Contrato es la representación de un Contrato y tiene relación a una Solicitud de Crédito.
Contrato ¶
GET staging.creditar.io/contracts/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"body": "Contrato del Crédito..."
}
],
"links": [
{
"rel": "self",
"uri": "/contracts/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Contrato"
},
"body": {
"type": "string",
"description": "Cuerpo del Contrato"
}
},
"required": [
"id",
"body"
]
},
"description": "Opciones del Contrato"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe.",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Obtener un ContratoGET/contracts/{id}
Obtiene los datos de un Contrato
URI Parameters
- id
string(required) Example: 0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5aiddel Contrato a obtener
Créditos ¶
Un Crédito es la representación de una Solicitud que fue aprobada y aceptada. Las operaciones sobre Créditos son de solo lectura.
Créditos ¶
Obtiene la lista de Créditos a partir de un Cliente.
GET staging.creditar.io/credits?customer_id=6313ac69-dc0d-45a8-8804-4ac451e1db5c
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": "636264b1-dc0d-453e-8804-4ac451e1dbd5",
"credit_application_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"contract_id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"credit_information": {
"capital_cents": 250000,
"outstanding_balance_cents": 150000,
"interest_paid_cents": 750,
"iva_paid_cents": 850,
"total_paid_cents": 170000
},
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"installment_plan": [
{
"number": 1,
"total_payment_cents": 85833,
"principal_cents": 83333,
"interest_cents": 250,
"interest_tax_cents": 4,
"ending_balance_cents": 916667,
"penalty_interest_cents": 0,
"penalty_interest_tax_cents": 0,
"payment_date": "2018-09-30",
"status": "cancelable",
"installment_id": "36841c73-a162-471e-a96a-3ff46b74a08c"
},
{
"number": 2,
"total_payment_cents": 85833,
"principal_cents": 83333,
"interest_cents": 250,
"interest_tax_cents": 4,
"ending_balance_cents": 833334,
"penalty_interest_cents": 0,
"penalty_interest_tax_cents": 0,
"payment_date": "2018-10-31",
"status": "pending",
"installment_id": "cf4d2982-cb2b-4b69-89a0-d6dc92bd5848"
},
{
"number": 3,
"total_payment_cents": 85833,
"principal_cents": 83333,
"interest_cents": 250,
"interest_tax_cents": 4,
"ending_balance_cents": 750001,
"penalty_interest_cents": 0,
"penalty_interest_tax_cents": 0,
"payment_date": "2018-11-30",
"status": "pending",
"installment_id": "b25ad8f0-162d-465f-b0fa-8fcda3ac54b2"
}
],
"created_at": "2018-09-11",
"updated_at": "2018-09-11"
}
],
"links": [
{
"rel": "self",
"uri": "/credits?customer_id=6313ac69-dc0d-45a8-8804-4ac451e1db5c"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Crédito"
},
"credit_application_id": {
"type": "string",
"description": "ID de la Solicitud de Crédito"
},
"customer_id": {
"type": "string",
"description": "ID del Cliente"
},
"contract_id": {
"type": "string",
"description": "ID del Contrato"
},
"credit_information": {
"type": "object",
"properties": {
"capital_cents": {
"type": "number",
"description": "Monto aprovado"
},
"outstanding_balance_cents": {
"type": "number",
"description": "Monto que se debe en centavos"
},
"interest_paid_cents": {
"type": "number",
"description": "Intereses pagados en centavos"
},
"iva_paid_cents": {
"type": "number",
"description": "IVA pagado en centavos"
},
"total_paid_cents": {
"type": "number",
"description": "Total pagado en centavos"
}
},
"required": [
"capital_cents",
"outstanding_balance_cents",
"interest_paid_cents",
"iva_paid_cents",
"total_paid_cents"
],
"description": "Información del Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"installment_plan": {
"type": "array",
"description": "Tabla de Amortización"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Crédito"
}
},
"required": [
"id",
"credit_application_id",
"customer_id",
"contract_id",
"credit_information",
"created_at",
"updated_at"
]
},
"description": "Créditos."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias."
}
},
"required": [
"data",
"links"
]
}Listar Créditos de un ClienteGET/credits{?customer_id}
URI Parameters
- customer_id
string(required) Example: 6313ac69-dc0d-45a8-8804-4ac451e1db5ciddel Cliente
Crédito ¶
Obtiene un solo Crédito y todos sus detalles.
GET staging.creditar.io/credits/636264b1-dc0d-453e-8804-4ac451e1dbd5
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"id": "636264b1-dc0d-453e-8804-4ac451e1dbd5",
"credit_application_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"contract_id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"credit_information": {
"capital_cents": 250000,
"outstanding_balance_cents": 150000,
"interest_paid_cents": 750,
"iva_paid_cents": 850,
"total_paid_cents": 170000
},
"accessories": [
{
"name": "Comisión por apertura",
"calculation_type": "percentage",
"calculation_base": "credit#ending_balance",
"calculate_iva": true,
"settings": {},
"days_offset": 0,
"active": true,
"fixed_value_cents": 170000,
"fixed_value_currency": "MXN",
"percentage": 1.5,
"payment_base": "credit#approved_amount"
}
],
"installment_plan": [
{
"number": 1,
"total_payment_cents": 85833,
"principal_cents": 83333,
"interest_cents": 250,
"interest_tax_cents": 4,
"ending_balance_cents": 916667,
"penalty_interest_cents": 0,
"penalty_interest_tax_cents": 0,
"payment_date": "2018-09-30",
"status": "cancelable",
"installment_id": "36841c73-a162-471e-a96a-3ff46b74a08c"
},
{
"number": 2,
"total_payment_cents": 85833,
"principal_cents": 83333,
"interest_cents": 250,
"interest_tax_cents": 4,
"ending_balance_cents": 833334,
"penalty_interest_cents": 0,
"penalty_interest_tax_cents": 0,
"payment_date": "2018-10-31",
"status": "pending",
"installment_id": "cf4d2982-cb2b-4b69-89a0-d6dc92bd5848"
},
{
"number": 3,
"total_payment_cents": 85833,
"principal_cents": 83333,
"interest_cents": 250,
"interest_tax_cents": 4,
"ending_balance_cents": 750001,
"penalty_interest_cents": 0,
"penalty_interest_tax_cents": 0,
"payment_date": "2018-11-30",
"status": "pending",
"installment_id": "b25ad8f0-162d-465f-b0fa-8fcda3ac54b2"
}
],
"created_at": "2018-09-11",
"updated_at": "2018-09-11"
}
],
"links": [
{
"rel": "self",
"uri": "/credits/636264b1-dc0d-453e-8804-4ac451e1dbd5"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Crédito"
},
"credit_application_id": {
"type": "string",
"description": "ID de la Solicitud de Crédito"
},
"customer_id": {
"type": "string",
"description": "ID del Cliente"
},
"contract_id": {
"type": "string",
"description": "ID del Contrato"
},
"credit_information": {
"type": "object",
"properties": {
"capital_cents": {
"type": "number",
"description": "Monto aprovado"
},
"outstanding_balance_cents": {
"type": "number",
"description": "Monto que se debe en centavos"
},
"interest_paid_cents": {
"type": "number",
"description": "Intereses pagados en centavos"
},
"iva_paid_cents": {
"type": "number",
"description": "IVA pagado en centavos"
},
"total_paid_cents": {
"type": "number",
"description": "Total pagado en centavos"
}
},
"required": [
"capital_cents",
"outstanding_balance_cents",
"interest_paid_cents",
"iva_paid_cents",
"total_paid_cents"
],
"description": "Información del Crédito"
},
"accessories": {
"type": "array",
"description": "Accesorios"
},
"installment_plan": {
"type": "array",
"description": "Tabla de Amortización"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Crédito"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Crédito"
}
},
"required": [
"id",
"credit_application_id",
"customer_id",
"contract_id",
"credit_information",
"created_at",
"updated_at"
]
},
"description": "Créditos."
},
"links": {
"type": "array",
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe.",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Obtener un CréditoGET/credits/{id}
URI Parameters
- id
string(required) Example: 636264b1-dc0d-453e-8804-4ac451e1dbd5iddel Crédito a obtener.
Pagos ¶
Un pago es la representación de un Pago.
Pagos ¶
Obtiene la lista de pagos a partir de un Crédito.
GET staging.creditar.io/payments?credit_id=86d90bd5-f1f7-4289-a520-fefd305d0616
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"installment_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"credit_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"amount_cents": 100000,
"payment_type": "annuity",
"payment_method": "SPEI",
"payment_reference": "RpFUx3tGeVVGuX7k9IyvRLYGhwVNoeF6uaOP46m6R7CcSzmR7I",
"status": "completed",
"prepaid_type": "not_reduce",
"created_at": "2018-09-11",
"updated_at": "2018-09-11"
}
],
"links": [
{
"rel": "self",
"uri": "/payments?credit_id=86d90bd5-f1f7-4289-a520-fefd305d0616"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del pago"
},
"installment_id": {
"type": "string",
"description": "ID del Plazo"
},
"credit_id": {
"type": "string",
"description": "ID del Crédito"
},
"amount_cents": {
"type": "number",
"description": "Monto capturado en centavos"
},
"payment_type": {
"type": "string",
"description": "Tipo de pago"
},
"payment_method": {
"type": "string",
"description": "Método de pago"
},
"payment_reference": {
"type": "string",
"description": "Referencia de pago"
},
"status": {
"type": "string",
"description": "Estatus del pago"
},
"prepaid_type": {
"type": "string",
"description": "Tipo de prepago"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Pago"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Pago"
}
},
"required": [
"id",
"installment_id",
"credit_id",
"amount_cents",
"payment_type",
"payment_method",
"payment_reference",
"status",
"prepaid_type",
"created_at",
"updated_at"
]
},
"description": "Pagos."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias."
}
},
"required": [
"data",
"links"
]
}Listar Pagos de un CréditoGET/payments{?credit_id}
URI Parameters
- credit_id
string(required) Example: 86d90bd5-f1f7-4289-a520-fefd305d0616iddel Crédito
POST staging.creditar.io/payments
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"installment_id": "9270cc36-5f90-448a-8fd8-cff7c7bd1f75",
"amount_cents": 100000,
"payment_type": "annuity",
"prepaid_type": "not_reduce",
"payment_reference": "RpFUx3tGeVVGuX7k9IyvRLYGhwVNoeF6uaOP46m6R7CcSzmR7I",
"payment_method": "SPEI",
"forgive_penalty_interest": "true"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"installment_id": {
"type": "string",
"description": "ID del Plazo"
},
"amount_cents": {
"type": "number",
"description": "Monto en centados"
},
"payment_type": {
"type": "string",
"description": "Tipo de pago"
},
"prepaid_type": {
"type": "string",
"description": "Tipo de prepago"
},
"payment_reference": {
"type": "string",
"description": "Referencia de pago"
},
"payment_method": {
"type": "string",
"description": "Método de pago"
},
"forgive_penalty_interest": {
"type": "string",
"description": "Condonar los intereses moratorios"
}
},
"required": [
"installment_id",
"amount_cents",
"payment_type",
"prepaid_type",
"payment_reference",
"payment_method",
"forgive_penalty_interest"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"installment_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"credit_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"amount_cents": 100000,
"payment_type": "annuity",
"payment_method": "SPEI",
"payment_reference": "RpFUx3tGeVVGuX7k9IyvRLYGhwVNoeF6uaOP46m6R7CcSzmR7I",
"status": "completed",
"prepaid_type": "not_reduce",
"created_at": "2018-09-11",
"updated_at": "2018-09-11"
}
],
"links": [
{
"rel": "self",
"uri": "/payments/3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del pago"
},
"installment_id": {
"type": "string",
"description": "ID del Plazo"
},
"credit_id": {
"type": "string",
"description": "ID del Crédito"
},
"amount_cents": {
"type": "number",
"description": "Monto capturado en centavos"
},
"payment_type": {
"type": "string",
"description": "Tipo de pago"
},
"payment_method": {
"type": "string",
"description": "Método de pago"
},
"payment_reference": {
"type": "string",
"description": "Referencia de pago"
},
"status": {
"type": "string",
"description": "Estatus del pago"
},
"prepaid_type": {
"type": "string",
"description": "Tipo de prepago"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Pago"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Pago"
}
},
"required": [
"id",
"installment_id",
"credit_id",
"amount_cents",
"payment_type",
"payment_method",
"payment_reference",
"status",
"prepaid_type",
"created_at",
"updated_at"
]
},
"description": "Pagos."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "less_than_or_not_a_number",
"code": "ERR-183",
"message": "El monto capturado en centavos debe ser mayor al total de la anualidad o es invalido",
"href": "staging.creditar.io/api/documentation#err-183"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Crear un PagoPOST/payments
Crea un nuevo Pago. Recibe un objeto JSON con el ID del Plazo (installment_id) a la que pertenecerá junto con sus demás atributos.
Antes de crear un Pago usted debe conocer los siguientes atributos con lista de opciones:
Tipos de pagos (payment_type)
| Valor | Descripción |
|---|---|
| annuity | Pago de la Anualidad |
| ending_balance | Pago del Saldo Insoluto |
| partial | Pago Parcial |
Nota: Cuando usted haya seleccionado un Tipo de Pago partial usted debera mandar otro atributo con los siguiente lista de opciones para indicar que Tipo de Prepago prepaid_type necesita aplicar.
Tipos de Prepago (prepaid_type)
| Valor | Descripción |
|---|---|
| not_reduce | Ninguno |
| reduce_annuity | Reducir la Anualidad |
| reduce_installments_number | Reducir el número de Plazos |
| reduce_installments_automatically | Reducir los Plazos automaticamente |
Cuando usted vaya a crear un Pago de tipo Pago Parcial con Tipo de Prepago reducir el número de plazos, usted debe mandar el atributo installments_number con valor entero el número de plazos a reducir.
Movimientos ¶
Los Movimientos existen en el contexto de un Crédito con un Producto con un sistema de amortización de Línea de Crédito.
Movimientos ¶
En esta ruta se podrán crear nuevos Movimientos en el Crédito específicado.
GET staging.creditar.io/movements?credit_id=615d723a-597b-4b7e-ae62-024b9c8dbf34&cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8&start_at=2020-02-01&end_at=2020-02-29
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"reference": "Compra a comercio",
"amount_cents": 100000,
"credit_id": "97a03292-c521-4495-813d-173d7f371c62",
"movement_type": "cargo",
"interest": false,
"folio_number": "DWJDHQY",
"id": "5c9d3d7b-3f64-4a6e-82e2-18acc95870c9",
"created_at": "2020-02-05"
}
],
"pagination": {
"cursors": {
"after": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"next_uri": "/movements?cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8"
}
},
"links": [
{
"rel": "self",
"uri": "/movements"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Referencia del Movimiento"
},
"amount_cents": {
"type": "number",
"description": "Monto en centavos del Movimiento"
},
"credit_id": {
"type": "string",
"description": "ID del Crédito del Movimiento"
},
"movement_type": {
"type": "string",
"description": "Tipo de movimiento del Movimiento"
},
"interest": {
"type": "boolean",
"description": "Interés del Movimiento"
},
"folio_number": {
"type": "string",
"description": "Identificador"
},
"id": {
"type": "string",
"description": "ID único del Movimiento"
},
"created_at": {
"type": "string",
"description": "Fecha de creación del Movimiento"
}
},
"required": [
"reference",
"amount_cents",
"credit_id",
"interest",
"folio_number",
"id"
]
},
"description": "Movimientos"
},
"pagination": {
"type": "object",
"properties": {
"cursors": {
"type": "object",
"properties": {
"after": {
"type": "string",
"description": "Cursor al siguiente registro."
},
"next_uri": {
"type": "string",
"description": "URL para la siguiente página."
}
},
"description": "Cursores"
}
},
"description": "Información sobre la Paginación"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias."
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [],
"pagination": {},
"links": [
{
"rel": "self",
"uri": "/movements"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Movimientos"
},
"pagination": {
"type": "object",
"properties": {
"cursors": {
"type": "object",
"properties": {},
"description": "Cursores"
}
},
"description": "Información sobre la Paginación"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias."
}
},
"required": [
"data",
"links"
]
}Listar todos los MovimientosGET/movements{?credit_id,cursor,start_at,end_at}
La obtención de la lista de Movimiento de un Crédito es una acción paginada. Se puede pasar el parámetro opcional cursor para obtener la siguiente página de Movimientos. Esta ruta siempre regresará 20 Movimientos por página.
Para consultar Movimientos por un rango de fechas puede utilizar start_at como fecha inicial y end_at como fecha final.
URI Parameters
- credit_id
string(required) Example: 615d723a-597b-4b7e-ae62-024b9c8dbf34ID del Credito.
- cursor
string(optional) Example: 5a36f715-1815-453e-81c5-68d0d1f96bc8Referencia del Cursor utilizado para paginar.
- start_at
string(optional) Example: 2020-02-01Fecha inicial para consultar por rango de fecha.
- end_at
string(optional) Example: 2020-02-29Fecha final para consultar por rango de fecha.
POST staging.creditar.io/movements
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"reference": "Compra a comercio",
"amount_cents": 100000,
"credit_id": "8b3825a0-a0da-424c-9856-bdb126b60860",
"movement_type": "cargo",
"interest": false,
"folio_number": "DWJDHQY"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Referencia del Movimiento"
},
"amount_cents": {
"type": "number",
"description": "Monto en centavos del Movimiento"
},
"credit_id": {
"type": "string",
"description": "ID del Crédito del Movimiento"
},
"movement_type": {
"type": "string",
"description": "Tipo de movimiento del Movimiento"
},
"interest": {
"type": "boolean",
"description": "Interés del Movimiento"
},
"folio_number": {
"type": "string",
"description": "Identificador"
}
},
"required": [
"reference",
"amount_cents",
"credit_id",
"interest",
"folio_number"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"reference": "Compra a comercio",
"amount_cents": 100000,
"credit_id": "97a03292-c521-4495-813d-173d7f371c62",
"movement_type": "cargo",
"interest": false,
"folio_number": "DWJDHQY",
"id": "5c9d3d7b-3f64-4a6e-82e2-18acc95870c9",
"created_at": "2020-02-05"
}
],
"links": [
{
"rel": "self",
"uri": "/movements/732aa212-2a91-4471-8a67-5be9403680bd"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Referencia del Movimiento"
},
"amount_cents": {
"type": "number",
"description": "Monto en centavos del Movimiento"
},
"credit_id": {
"type": "string",
"description": "ID del Crédito del Movimiento"
},
"movement_type": {
"type": "string",
"description": "Tipo de movimiento del Movimiento"
},
"interest": {
"type": "boolean",
"description": "Interés del Movimiento"
},
"folio_number": {
"type": "string",
"description": "Identificador"
},
"id": {
"type": "string",
"description": "ID único del Movimiento"
},
"created_at": {
"type": "string",
"description": "Fecha de creación del Movimiento"
}
},
"required": [
"reference",
"amount_cents",
"credit_id",
"interest",
"folio_number",
"id"
]
},
"description": "Movimientos"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_a_number",
"code": "ERR-140",
"message": "La cantidad debe ser un número",
"href": "staging.creditar.io/api/documentation#err-140"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Crear un movimientoPOST/movements
Crea un nuevo Movimiento. Recibe un objeto JSON con el credit_id del Crédito a la que pertecenerá junto con sus demás atributos.
Movimiento ¶
GET staging.creditar.io/movements/998ce380-2a64-4ec8-b414-bbe43b30fa78
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"reference": "Compra a comercio",
"amount_cents": 100000,
"credit_id": "97a03292-c521-4495-813d-173d7f371c62",
"movement_type": "cargo",
"interest": false,
"folio_number": "DWJDHQY",
"id": "5c9d3d7b-3f64-4a6e-82e2-18acc95870c9",
"created_at": "2020-02-05"
}
],
"links": [
{
"rel": "self",
"uri": "/movements/9b12f515-10fe-421a-9200-54a98d25f059"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Referencia del Movimiento"
},
"amount_cents": {
"type": "number",
"description": "Monto en centavos del Movimiento"
},
"credit_id": {
"type": "string",
"description": "ID del Crédito del Movimiento"
},
"movement_type": {
"type": "string",
"description": "Tipo de movimiento del Movimiento"
},
"interest": {
"type": "boolean",
"description": "Interés del Movimiento"
},
"folio_number": {
"type": "string",
"description": "Identificador"
},
"id": {
"type": "string",
"description": "ID único del Movimiento"
},
"created_at": {
"type": "string",
"description": "Fecha de creación del Movimiento"
}
},
"required": [
"reference",
"amount_cents",
"credit_id",
"interest",
"folio_number",
"id"
]
},
"description": "Movimientos"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Obtener un MovimientoGET/movements/{id}
Obtiene un Movimiento existente.
URI Parameters
- id
string(required) Example: 998ce380-2a64-4ec8-b414-bbe43b30fa78idófolio_numberdel Movimiento a obtener
Ingresos ¶
Los Ingresos existen en el contexto de una Solicitud de Crédito, es por ello que para la mayoría de sus operaciones será necesario el ID de la Solicitud de Crédito a la que pertenecen/pertenecerán.
Ingresos ¶
En esta ruta se podrán crear nuevos Ingresos en la Solicitud de Crédito específicada.
POST staging.creditar.io/incomes
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"classification": "Trabajo",
"amount_cents": 450000,
"credit_application_id": "636264b1-77a2-45ef-b643-e44cfbc84d40"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Ingreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Ingreso"
},
"credit_application_id": {
"type": "string"
}
},
"required": [
"classification",
"amount_cents",
"credit_application_id"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"classification": "Trabajo",
"amount_cents": 450000,
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"created_at": "2018-07-02"
}
],
"links": [
{
"rel": "self",
"uri": "/incomes/3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Ingreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Ingreso"
},
"id": {
"type": "string",
"description": "ID único del Ingreso"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Ingreso"
}
},
"required": [
"classification",
"amount_cents",
"id",
"created_at"
]
},
"description": "Ingresos"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_a_number",
"code": "ERR-140",
"message": "La cantidad debe ser un número",
"href": "staging.creditar.io/api/documentation#err-140"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Crear un IngresoPOST/incomes
Crea un nuevo Ingreso. Recibe un objeto JSON con el ID de la Solicitud a la que pertenecerá junto con sus demás atributos.
Ingreso ¶
DELETE staging.creditar.io/incomes/6313ac69-dc0d-45a8-8804-4ac451e1db5c
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeHeaders
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Eliminar un IngresoDELETE/incomes/{id}
Elimina el registro de un Ingreso. Regresa una respuesta vacía con un código de estado HTTP 204.
URI Parameters
- id
string(required) Example: 6313ac69-dc0d-45a8-8804-4ac451e1db5ciddel Ingreso a obtener
GET staging.creditar.io/incomes/6313ac69-dc0d-45a8-8804-4ac451e1db5c
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"classification": "Trabajo",
"amount_cents": 450000,
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"created_at": "2018-07-02"
}
],
"links": [
{
"rel": "self",
"uri": "/incomes/3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Ingreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Ingreso"
},
"id": {
"type": "string",
"description": "ID único del Ingreso"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Ingreso"
}
},
"required": [
"classification",
"amount_cents",
"id",
"created_at"
]
},
"description": "Ingresos"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Obtener un IngresoGET/incomes/{id}
Obtiene un Ingreso existente.
URI Parameters
- id
string(required) Example: 6313ac69-dc0d-45a8-8804-4ac451e1db5ciddel Ingreso a obtener
Egresos ¶
Los Egresos existen en el contexto de una Solicitud de Crédito, es por ello que para la mayoría de sus operaciones será necesario el ID de la Solicitud de Crédito a la que pertenecen/pertenecerán.
Egresos ¶
En esta ruta se podrán crear nuevos Egresos en la Solicitud de Crédito específicada.
POST staging.creditar.io/expenses
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"classification": "Renta",
"amount_cents": 250000,
"credit_application_id": "636264b1-77a2-45ef-b643-e44cfbc84d40"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Egreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Egreso"
},
"credit_application_id": {
"type": "string"
}
},
"required": [
"classification",
"amount_cents",
"credit_application_id"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"classification": "Renta",
"amount_cents": 250000,
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"created_at": "2018-07-02"
}
],
"links": [
{
"rel": "self",
"uri": "/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Egreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Egreso"
},
"id": {
"type": "string",
"description": "ID único del Egreso"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Egreso"
}
},
"required": [
"classification",
"amount_cents",
"id",
"created_at"
]
},
"description": "Egresos"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "not_a_number",
"code": "ERR-150",
"message": "La cantidad debe ser un número",
"href": "staging.creditar.io/api/documentation#err-150"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Crear un EgresoPOST/expenses
Crea un nuevo Egreso. Recibe un objeto JSON con el ID de la Solicitud a la que pertenecerá junto con sus demás atributos.
Egreso ¶
DELETE staging.creditar.io/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeHeaders
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Eliminar un EgresoDELETE/expenses/{id}
Elimina el registro de un Egreso. Regresa una respuesta vacía con un código de estado HTTP 204.
URI Parameters
- id
string(required) Example: eeedba2e-fc96-4f96-bd2e-bd046b256f96iddel Egreso a obtener
GET staging.creditar.io/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"classification": "Renta",
"amount_cents": 250000,
"id": "eeedba2e-fc96-4f96-bd2e-bd046b256f96",
"created_at": "2018-07-02"
}
],
"links": [
{
"rel": "self",
"uri": "/expenses/eeedba2e-fc96-4f96-bd2e-bd046b256f96"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación del Egreso"
},
"amount_cents": {
"type": "number",
"description": "Cantidad Total en centavos del Egreso"
},
"id": {
"type": "string",
"description": "ID único del Egreso"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Egreso"
}
},
"required": [
"classification",
"amount_cents",
"id",
"created_at"
]
},
"description": "Egresos"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Obtener un EgresoGET/expenses/{id}
Obtiene un Egreso existente.
URI Parameters
- id
string(required) Example: eeedba2e-fc96-4f96-bd2e-bd046b256f96iddel Egreso a obtener
Referencias ¶
Las Referencias existen en el contexto de una Solicitud de Crédito, es por ello que para la mayoría de sus operaciones será necesario el ID de la Solicitud de Crédito a la que pertenecen/pertenecerán.
Referencias ¶
En esta ruta se podrán crear nuevas Referencias en la Solicitud de Crédito específicada.
POST staging.creditar.io/references
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"classification": "Renta",
"name": "Rigoberto Villegas",
"phone": "3121159945",
"credit_application_id": "636264b1-77a2-45ef-b643-e44cfbc84d40"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación de la Referencia"
},
"name": {
"type": "string",
"description": "Nombre de la Referencia"
},
"phone": {
"type": "string",
"description": "Teléfono de la Referencia"
},
"credit_application_id": {
"type": "string"
}
},
"required": [
"classification",
"name",
"phone",
"credit_application_id"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"classification": "Renta",
"name": "Rigoberto Villegas",
"phone": "3121159945",
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"created_at": "2018-07-02"
}
],
"links": [
{
"rel": "self",
"uri": "/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación de la Referencia"
},
"name": {
"type": "string",
"description": "Nombre de la Referencia"
},
"phone": {
"type": "string",
"description": "Teléfono de la Referencia"
},
"id": {
"type": "string",
"description": "ID único de la Referencia"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Egreso"
}
},
"required": [
"classification",
"name",
"phone",
"id",
"created_at"
]
},
"description": "Referencias"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "blank",
"code": "ERR-160",
"message": "El teléfono no debe estar vacío.",
"href": "staging.creditar.io/api/documentation#err-160"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Crear una ReferenciaPOST/references
Crea una nueva Referencia. Recibe un objeto JSON con el ID de la Solicitud a la que pertenecerá junto con sus demás atributos.
Referencia ¶
DELETE staging.creditar.io/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeHeaders
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "La recurso no existe",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Eliminar una ReferenciaDELETE/references/{id}
Elimina el registro de una Referencia. Regresa una respuesta vacía con un código de estado HTTP 204.
URI Parameters
- id
string(required) Example: 0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5aiddel Referencia a obtener
GET staging.creditar.io/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"classification": "Renta",
"name": "Rigoberto Villegas",
"phone": "3121159945",
"id": "0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a",
"created_at": "2018-07-02"
}
],
"links": [
{
"rel": "self",
"uri": "/references/0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5a"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Clasificación de la Referencia"
},
"name": {
"type": "string",
"description": "Nombre de la Referencia"
},
"phone": {
"type": "string",
"description": "Teléfono de la Referencia"
},
"id": {
"type": "string",
"description": "ID único de la Referencia"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Egreso"
}
},
"required": [
"classification",
"name",
"phone",
"id",
"created_at"
]
},
"description": "Referencias"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "La recurso no existe",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Obtener una ReferenciaGET/references/{id}
Obtiene una Referencia existente.
URI Parameters
- id
string(required) Example: 0b19e3b6-9fae-40e1-a7c2-f2db1cae8a5aiddel Referencia a obtener
Catálogos ¶
Un catálogo contiene una lista de los posibles valores que determinados campos pueden tomar.
Catálogos ¶
GET staging.creditar.io/catalogs?resource=customer
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"resource": "customer",
"field": "source"
},
{
"resource": "credit_application",
"field": "classification"
}
],
"links": [
{
"rel": "self",
"uri": "/catalogs"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"resource": {
"type": "string",
"description": "Nombre del Recurso"
},
"field": {
"type": "string",
"description": "Nombre del Campo"
}
},
"required": [
"resource",
"field"
]
},
{
"type": "object",
"properties": {
"resource": {
"type": "string",
"description": "Nombre del Recurso"
},
"field": {
"type": "string",
"description": "Nombre del Campo"
}
},
"required": [
"resource",
"field"
]
}
],
"description": "Catálogos Existentes"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Listar los Catálogos disponiblesGET/catalogs{?resource}
Obtiene la lista completa de los Campos/Recursos que tienen uno o más valores asociados. Con la información listada en esta ruta,
se podrán obtener los valores asociados utilizando los datos de resource y field.
URI Parameters
- resource
string(optional) Example: customerNombre del Recurso, sirve para filtrar Catálogos.
Catálogo ¶
GET staging.creditar.io/catalogs?resource=customer&field=source
Responses
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"data": [
{
"name": "revista",
"value": "Revista"
},
{
"name": "redes",
"value": "Redes Sociales"
}
],
"links": [
{
"rel": "self",
"uri": "/catalogs?resource=customer&field=source"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre de la opción de Catálogo"
},
"value": {
"type": "string",
"description": "Valor de la opción de Catálogo"
}
},
"required": [
"name",
"value"
]
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre de la opción de Catálogo"
},
"value": {
"type": "string",
"description": "Valor de la opción de Catálogo"
}
},
"required": [
"name",
"value"
]
}
],
"description": "Opciones del Catálogo"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rel": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"rel",
"uri"
]
},
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "not_found",
"code": "ERR-404",
"message": "El recurso no existe.",
"href": "staging.creditar.io/api/documentation#err-404"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Tipo del Error"
},
"code": {
"type": "string",
"description": "Código único del Error"
},
"message": {
"type": "string",
"description": "Mensaje descriptivo del Error"
},
"href": {
"type": "string",
"description": "Enlace para obtener más información del Error"
}
},
"required": [
"type",
"code",
"message",
"href"
]
},
"description": "Error ocurrido"
}
},
"required": [
"errors"
]
}Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"errors": [
{
"type": "missing_parameters",
"code": "ERR-001",
"message": "Descripción del error",
"href": "staging.creditar.io/api/documentat