API de Aoorora
API Endpoint
https://staging.creditar.ioLa API de Aoorora está organizada usando REST.
JSON API ¶
La API de Aoorora 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 cambiarla en tu Panel de Administración.
Tu llave privada es solo para ti, mantenla segura. No la compartas públicamente, 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 https://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 Aoorora
-
Authorization
Authorization: Token token=your-api-key -
Accept (especificando que versión deseas utilizar)
Accept: application/vnd.creditar.v1+json -
Content-Type (peticiones diferentes a GET)
Content-Type: application/json
La API de Aoorora responderá con un código 401 si no se envía el header de Authorization y con un código 406 si es vació o incorrecto el header de Accept.
Versiones ¶
La API de Aoorora cuenta con algunas versiones disponibles para las actualizaciones en la API. La versión más actual es la Versión 2.
Listado de algunas versiones disponibles: Versión 1 y Versión 2.
Recuerda que para especificar a la API qué versión utilizar es necesario mandar el header Accept seguido de la versión.
-
Accept
Accept: application/vnd.creditar.v1+json
Changelog ¶
El Changelog es una lista de actualizaciones en la API incompatibles con versiones anteriores. Aquí encontrarás la información de una actualización de una versión.
Versión 1
En esta versión genérica es para un flujo de créditos tradicionales.
-
29/06/2021
- Se ha agregado un nuevo recurso crear movimientos del inversionista.
-
19/10/2020
- Se ha agregado un nuevo atributo para el recurso de Solicitudes que es
maximum_penalty_daysque indica la cantidad de días máximos sobre los que se cobran intereses moratorios por Crédito.
- Se ha agregado un nuevo atributo para el recurso de Solicitudes que es
-
13/08/2020
- Se ha agregado dos nuevos atributos para el recurso de Solicitudes que son
maximum_amount_allowed_centsymaximum_credit_allowedque mostraran información sobre los límites aplicados sobre la Solicitud por Cliente.
- Se ha agregado dos nuevos atributos para el recurso de Solicitudes que son
-
27/04/2020
- Se ha agregado un nuevo recurso para Calificar Flujo de Calificación de una solicitud.
-
17/04/2020
- En la creación de un Archivo la respuesta del recurso ha actualizado y agregamos en la respuesta los siguientes atributos
attachmentable_type,attachmentable_idy reemplazamosurlporfile.
- En la creación de un Archivo la respuesta del recurso ha actualizado y agregamos en la respuesta los siguientes atributos
-
18/03/2020
- Se agrega un nuevo atributo
uidpara auditar las actualizaciones del registro, este valor puede ser definido de manera abierta para el desarrollo final. Aplica solo Clientes, Solicitudes, Pagos, Ingresos, Egresos y Referencias.
- Se agrega un nuevo atributo
Versión 2
En esta versión genérica es para un flujo de tipos de créditos. En Créditos existen varios tipos como Crédito Simple, Línea de Crédito y Balance de Crédito. El Balance del Crédito es una relación perteneciente a una Línea de Crédito donde se concentra un balance de los Movimientos de tipo cargo y abono.
-
08/12/2021
-
Se ha agregado nuevos atributos
principal_paid_amount_cents,interest_paid_amount_cents,interest_tax_paid_amount_cents,penalty_interest_paid_amount_cents,penalty_interest_tax_paid_amount_cents,accessories_paid_amount_cents,profit_commission_amount_cents,profit_commission_tax_amount_centsy fueron remplazados porpaid_amount_cents,interest_paid_amount_centsytax_paid_amount_centsa los Fondos de un Inversionista. Esta información desglosa el pago de los rendimientos al Inversionista. -
También, se ha agregado en los Movimientos de un Inversionista el desglose de un pago con el atributo
breakdown_paymentcon la misma similitud de atributos anteriores.
-
-
29/06/2021
- Se ha agregado un nuevo recurso crear movimientos del inversionista.
-
19/10/2020
- Se ha agregado un nuevo atributo para el recurso de Solicitudes que es
maximum_penalty_daysque indica la cantidad de días máximos sobre los que se cobran intereses moratorios por Crédito.
- Se ha agregado un nuevo atributo para el recurso de Solicitudes que es
-
13/08/2020
- Se ha agregado dos nuevos atributos para el recurso de Solicitudes que son
maximum_amount_allowed_centsymaximum_credit_allowedque mostrarán información sobre los límites aplicados sobre la Solicitud por Cliente.
- Se ha agregado dos nuevos atributos para el recurso de Solicitudes que son
-
20/05/2020
- Se ha agregado un nuevo recurso para Convertir Solicitudes a Crédito.
-
27/04/2020
- Se ha agregado un nuevo recurso para Calificar Flujo de Calificación de una solicitud.
-
17/04/2020
- En la creación de un Archivo la respuesta del recurso ha actualizado y agregamos en la respuesta los siguientes atributos
attachmentable_type,attachmentable_idy reemplazamosurlporfile.
- En la creación de un Archivo la respuesta del recurso ha actualizado y agregamos en la respuesta los siguientes atributos
-
13/04/2020
- Se agrega un nuevo atributo
uidpara auditar las actualizaciones del registro, este valor puede ser definido de manera abierta para el desarrollo final. Aplica solo Clientes, Solicitudes, Pagos, Movimientos, Ingresos, Egresos y Referencias.
- Se agrega un nuevo atributo
Sandbox ¶
Para habilitar en modo entorno de pruebas es obligatorio agregar el siguiente header en la petición a realizar en la API de Aoorora
-
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 sólo listará los Productos activos.
GET https://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...",
"crowdfunding": true,
"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"
}
],
"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"
},
"crowdfunding": {
"type": "boolean",
"description": "Recaudación de fondos"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catálogo 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"
}
},
"required": [
"id"
]
},
"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.
Puedes utilizar algunos de los siguientes parámetros como filtros:
| Parámetro | Tipo de filtro | Descripción |
|---|---|---|
by_created_at |
Rango de fecha | Filtra por fecha de creación |
by_updated_at |
Rango de fecha | Filtra por fecha de última modificación |
URI Parameters
- cursor
string(required) Example: 5a36f715-1815-453e-81c5-68d0d1f96bc8Referencia del Cursor utilizado para paginar.
Producto ¶
Obtiene un solo Producto y todos sus detalles.
GET https://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...",
"crowdfunding": true,
"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"
}
],
"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"
},
"crowdfunding": {
"type": "boolean",
"description": "Recaudación de fondos"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catálogo 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"
}
},
"required": [
"id"
]
},
"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": "https://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 https://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": "https://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": "https://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
Calificar Flujos de Calificación ¶
Calificación ¶
En esta ruta se podrá generar una calificación para el flujo de calificación de la solicitud deseada
POST https://staging.creditar.io/qualify_score_flows
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"credit_application_id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"credit_application_id": {
"type": "string",
"description": "ID de la Solicitud a la que se le desea crear la calificación"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"value": "10",
"notes": "Valores proporcionados correctamente",
"passed": true,
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"created_at": "2018-07-02",
"updated_at": "2018-05-02"
}
],
"links": [
{
"rel": "self",
"uri": "/qualify_score_flows"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Valor de la Calificación"
},
"notes": {
"type": "string",
"description": "Notas de la Calificación"
},
"passed": {
"type": "boolean",
"description": "Indica si el flujo pasó la Calificación"
},
"id": {
"type": "string",
"description": "ID único de la Calificación"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Calificación"
},
"updated_at": {
"type": "string",
"description": "Última modificación a la Calificación"
}
},
"required": [
"value",
"notes",
"passed",
"id",
"created_at",
"updated_at"
]
},
"description": "Calificación del Flujo de Calificació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/jsonBody
{
"errors": [
{
"type": "invalid",
"code": "ERR-196",
"message": "Existe uno o más Componentes en el Flujo de Calificación que necesitan atención",
"href": "https://staging.creditar.io/api/documentation#err-196"
}
]
}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 calificaciónPOST/qualify_score_flows
Crea una nueva calificación para un flujo de calificación. Recibe un objeto JSON con el ID de la Solicitud (credit_application_id) a la que pertenece.
Clientes ¶
Cliente es una representación de un Cliente.
Clientes ¶
Esta ruta regresará una lista de Clientes.
GET https://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",
"metadata": {},
"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"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales 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",
"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.
Puedes utilizar algunos de los siguientes parámetros como filtros:
| Parámetro | Tipo de filtro | Descripción |
|---|---|---|
by_metadata |
JSON | Filtra por atributos especiales |
by_blocked |
Boleano | Filtra por estado del bloqueo |
by_created_at |
Rango de fecha | Filtra por fecha de creación |
by_updated_at |
Rango de fecha | Filtra por fecha de última modiificación |
URI Parameters
- cursor
string(required) Example: 5a36f715-1815-453e-81c5-68d0d1f96bc8Referencia del Cursor utilizado para paginar.
POST https://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",
"metadata": {},
"uid": "1"
}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"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales del Cliente"
},
"uid": {
"type": "string",
"description": "ID de usuario que realizó última modificación"
}
},
"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",
"metadata": {},
"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"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales 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",
"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": "https://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 https://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",
"metadata": {},
"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"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales 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",
"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": "https://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",
"metadata": {},
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"blocked": false,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"attachments": [
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"attachmentable_type": "customer",
"attachmentable_id": "73676276-221c-40ac-af43-ab2f3f72a48c",
"attachment_type": "INE",
"file": "https://staging.creditar.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--19f8c22c36866305fa3878fe3a04e19a0fc6f4d1/WhatsApp%20Image%202018-03-06%20at%208.24.22%20PM.pdf",
"created_at": "2020-04-17T12:55:47.220-05:0"
}
]
}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"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales 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": {
"id": {
"type": "string",
"description": "ID único del Archivo"
},
"attachmentable_type": {
"type": "string",
"description": "Representa el recurso"
},
"attachmentable_id": {
"type": "string",
"description": "Representa el ID del recurso"
},
"attachment_type": {
"type": "string",
"description": "Tipo de documento del Archivo"
},
"file": {
"type": "string",
"description": "URL del Archivo"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Archivo"
}
},
"required": [
"id",
"attachmentable_type",
"attachmentable_id",
"attachment_type",
"file",
"created_at"
]
},
"description": "Archivos"
}
},
"required": [
"email",
"id",
"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",
"metadata": {},
"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",
"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"
},
"created_at": "2018-05-02",
"updated_at": "2018-05-02"
}
]
}
],
"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"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales 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"
},
"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"
},
"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": [
"id",
"application_number",
"customer_id",
"created_at",
"updated_at"
]
},
"description": "Solicitudes de Crédito"
}
},
"required": [
"email",
"id",
"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",
"metadata": {},
"id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"blocked": false,
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"credit_applications": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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...",
"crowdfunding": true,
"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"
},
"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"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales 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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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"
},
"crowdfunding": {
"type": "boolean",
"description": "Recaudación de fondos"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catálogo 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"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"crowdfunding",
"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"
],
"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": [
"product_id",
"customer_id",
"id",
"application_number"
]
}
}
},
"required": [
"email",
"id",
"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 separados 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-4ac451e1db5cID único del Cliente a obtener
- include
string(required) Example: credit_application,productCadena de texto para indicar si la respuesta debe incluir recursos relacionados.
PATCH https://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",
"metadata": {},
"uid": "1"
}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"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales del Cliente"
},
"uid": {
"type": "string",
"description": "ID de usuario que realizó última modificación"
}
},
"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",
"metadata": {},
"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"
},
"metadata": {
"type": "object",
"properties": {},
"description": "Atributos especiales 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",
"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": "https://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": "https://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": "https://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-4ac451e1db5cID único del Cliente a obtener
- include
string(required) 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 https://staging.creditar.io/applications?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": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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": [
"product_id",
"customer_id",
"id",
"application_number"
]
},
"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}
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.
Puedes utilizar algunos de los siguientes parámetros como filtros:
| Parámetro | Tipo de filtro | Descripción |
|---|---|---|
by_customer_id |
Scope | Filtra por uuid del Cliente |
by_metadata |
JSON | Filtra por atributos especiales |
by_flow |
Cadena | Filtra por paso actual del flujo de la solicitud de crédito |
by_classification |
Cadena | Filtra por clasificación de la solicitud de crédito |
by_state |
Cadena | Filtra por estado actual de la solicitud de crédito |
by_amount_cents |
Entero | Filtra por total del monto solicitado de la solicitud de crédito |
by_approved_amount_cents |
Entero | Filtra por cantidad aprobada del crédito solicitado |
by_rejected_at |
Rango de fecha | Filtra por fecha de rechazo |
by_approved_at |
Rango de fecha | Filtra por fecha de aprobación |
by_accepted_at |
Rango de fecha | Filtra por fecha de aceptación |
by_created_at |
Rango de fecha | Filtra por fecha de creación |
by_updated_at |
Rango de fecha | Filtra por fecha de última modificación |
URI Parameters
- cursor
string(required) Example: 5a36f715-1815-453e-81c5-68d0d1f96bc8Referencia del Cursor utilizado para paginar.
POST https://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",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"uid": "1"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"uid": {
"type": "string",
"description": "ID de usuario que realizó última modificación"
}
},
"required": [
"product_id",
"customer_id"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "",
"amount_cents": 0,
"installments": 0,
"street_address": "",
"exterior_number_address": "",
"interior_number_address": "",
"neighborhood_address": "",
"state_address": "",
"city_address": "",
"zipcode_address": "",
"home_phone": "",
"mobile_phone": "",
"classification": "",
"description": "",
"metadata": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "",
"rejected_notes": "",
"approved_at": "",
"approved_amount_cents": 0,
"accepted_at": "",
"first_payment_date": "2018-06-01",
"state": "",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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...",
"crowdfunding": true,
"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"
},
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string",
"description": "ID del Customer"
},
"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"
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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"
},
"crowdfunding": {
"type": "boolean",
"description": "Recaudación de fondos"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catálogo 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"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"crowdfunding",
"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"
],
"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": [
"product_id",
"customer_id",
"id",
"application_number"
]
},
"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": "https://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 https://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": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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": [
"product_id",
"customer_id",
"id",
"application_number",
"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": "https://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": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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...",
"crowdfunding": true,
"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"
},
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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"
},
"crowdfunding": {
"type": "boolean",
"description": "Recaudación de fondos"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catálogo 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"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"crowdfunding",
"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"
],
"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": [
"product_id",
"customer_id",
"id",
"application_number",
"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": {
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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": [
"product_id",
"customer_id",
"flow",
"amount_cents",
"installments",
"street_address",
"exterior_number_address",
"interior_number_address",
"neighborhood_address",
"state_address",
"city_address",
"zipcode_address",
"home_phone",
"mobile_phone",
"classification",
"description",
"metadata",
"clabe",
"maximum_penalty_days",
"id",
"application_number",
"rejected_at",
"rejected_notes",
"approved_at",
"approved_amount_cents",
"accepted_at",
"first_payment_date",
"state",
"i18_state",
"accessories",
"maximum_amount_allowed_cents",
"maximum_credit_allowed",
"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": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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": [
"product_id",
"customer_id",
"id",
"application_number",
"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": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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": [
"product_id",
"customer_id",
"id",
"application_number",
"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": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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": [
"product_id",
"customer_id",
"id",
"application_number",
"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": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"attachmentable_type": "customer",
"attachmentable_id": "73676276-221c-40ac-af43-ab2f3f72a48c",
"attachment_type": "INE",
"file": "https://staging.creditar.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--19f8c22c36866305fa3878fe3a04e19a0fc6f4d1/WhatsApp%20Image%202018-03-06%20at%208.24.22%20PM.pdf",
"created_at": "2020-04-17T12:55:47.220-05:0"
}
]
}
],
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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"
},
"attachmentable_type": {
"type": "string",
"description": "Representa el recurso"
},
"attachmentable_id": {
"type": "string",
"description": "Representa el ID del recurso"
},
"attachment_type": {
"type": "string",
"description": "Tipo de documento del Archivo"
},
"file": {
"type": "string",
"description": "URL del Archivo"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Archivo"
}
},
"required": [
"id",
"attachmentable_type",
"attachmentable_id",
"attachment_type",
"file",
"created_at"
]
}
}
},
"required": [
"product_id",
"customer_id",
"id",
"application_number",
"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": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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...",
"crowdfunding": true,
"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"
},
"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": [
{
"id": "3c8b46ce-a5f2-4f25-8280-a80551eacd21",
"attachmentable_type": "customer",
"attachmentable_id": "73676276-221c-40ac-af43-ab2f3f72a48c",
"attachment_type": "INE",
"file": "https://staging.creditar.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--19f8c22c36866305fa3878fe3a04e19a0fc6f4d1/WhatsApp%20Image%202018-03-06%20at%208.24.22%20PM.pdf",
"created_at": "2020-04-17T12:55:47.220-05:0"
}
]
}
],
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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"
},
"crowdfunding": {
"type": "boolean",
"description": "Recaudación de fondos"
},
"payment_periodicity_label": {
"type": "string",
"description": "Nombre del valor del Catálogo 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"
}
},
"required": [
"id",
"short_name",
"name",
"interest_rate",
"interest_rate_days",
"tax",
"description",
"crowdfunding",
"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"
],
"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": {
"id": {
"type": "string",
"description": "ID único del Archivo"
},
"attachmentable_type": {
"type": "string",
"description": "Representa el recurso"
},
"attachmentable_id": {
"type": "string",
"description": "Representa el ID del recurso"
},
"attachment_type": {
"type": "string",
"description": "Tipo de documento del Archivo"
},
"file": {
"type": "string",
"description": "URL del Archivo"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Archivo"
}
},
"required": [
"id",
"attachmentable_type",
"attachmentable_id",
"attachment_type",
"file",
"created_at"
]
}
}
},
"required": [
"product_id",
"customer_id",
"id",
"application_number",
"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:
-
ongoing- Se encuentra en trámite sin datos y lista para completarla. -
score_flow- Se encuentra en calificación. Ha sido calificada por un Flujo de Calificación desde el Dashboard. -
rejected- 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. -
crowdfund- Se encuentra en campaña. Para que este en campaña por financiamiento colectivo es necesario crear una campaña relacionada con la Solicitud. -
approved- 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. -
accepted- 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. -
has_credit- Se encuentra en Crédito. Nota: Para convertir una Solicitud previamente aceptada es necesario convertirla desde el Dashboard de Aoorora
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 https://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",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"uid": "1"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"uid": {
"type": "string",
"description": "ID de usuario que realizó última modificación"
}
},
"required": [
"product_id",
"customer_id",
"rejected_at",
"rejected_notes",
"approved_at",
"approved_amount_cents",
"accepted_at"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"product_id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"customer_id": "6313ac69-dc0d-45a8-8804-4ac451e1db5c",
"flow": "inicio",
"amount_cents": 500000,
"installments": 12,
"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": {},
"clabe": "002115016003269411",
"maximum_penalty_days": 5,
"id": "636264b1-77a2-45ef-b643-e44cfbc84d40",
"application_number": "UENDSND-1",
"rejected_at": "2018-05-02",
"rejected_notes": "No actualizó su documentación a tiempo.",
"approved_at": "2018-05-02",
"approved_amount_cents": 0,
"accepted_at": "2018-05-01",
"first_payment_date": "2018-06-01",
"state": "ongoing",
"i18_state": "En trámite",
"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"
}
],
"maximum_amount_allowed_cents": 0,
"maximum_credit_allowed": 0,
"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": {
"product_id": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"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."
},
"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"
},
"clabe": {
"type": "string",
"description": "CLABE"
},
"maximum_penalty_days": {
"type": "number",
"description": "Días máximos de penalizaciones"
},
"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"
},
"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"
},
"approved_amount_cents": {
"type": "number",
"description": "Cantidad Aprobada del Crédito Solicitado"
},
"accepted_at": {
"type": "string",
"description": "Fecha de Aceptación"
},
"first_payment_date": {
"type": "string",
"description": "Fecha de pago inicial"
},
"state": {
"type": "string",
"description": "Estado actual de la Solicitud de Crédito"
},
"i18_state": {
"type": "string",
"description": "Traducción del estado actual de la Solicitud de Crédito"
},
"accessories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Nombre"
},
"calculation_type": {
"type": "string",
"description": "Tipo de cálculo"
},
"calculation_base": {
"type": "string",
"description": "Base de cálculo"
},
"calculate_iva": {
"type": "boolean",
"description": "Calcular IVA"
},
"settings": {
"type": "object",
"properties": {},
"description": "Configuraciones"
},
"days_offset": {
"type": "number",
"description": "Días de gracia"
},
"active": {
"type": "boolean",
"description": "Activo"
},
"fixed_value_cents": {
"type": "number",
"description": "Valor fijo en centavos"
},
"fixed_value_currency": {
"type": "string",
"description": "Valor fijo moneda"
},
"percentage": {
"type": "number",
"description": "Porcentaje"
},
"payment_base": {
"type": "string",
"description": "Base de cobro"
}
},
"required": [
"name",
"calculation_type",
"calculation_base",
"calculate_iva",
"settings",
"days_offset",
"active",
"fixed_value_cents",
"fixed_value_currency",
"percentage",
"payment_base"
]
},
"description": "Accesorios"
},
"maximum_amount_allowed_cents": {
"type": "number",
"description": "Cantidad restante en centavos que puede solicitar el Cliente. Cero si no hay restricción"
},
"maximum_credit_allowed": {
"type": "number",
"description": "Cantidad restante de créditos que puede solicitar el Cliente. Cero si no hay restricción"
},
"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": [
"product_id",
"customer_id",
"id",
"application_number",
"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": "https://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": "https://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.
Campañas de Fondos ¶
Una campaña de fondos es la representación de un recurso.
Campañas de Fondos ¶
Esta ruta solo listara las campañas de fondos.
GET https://staging.creditar.io/crowdfunding/crowdfunds?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": "868eca1c-9a1e-4d0d-a35a-3e5e47c52421",
"source_type": "Project",
"source_id": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"amount_cents": 200000000,
"collected_amount_cents": 2000000,
"status": "funded",
"expiration_date": "2019-07-08",
"success_percentage": "80",
"funds_without_limit": true,
"campaign_days": 10,
"funded_at": "2019-07-07",
"canceled_at": "2019-07-05",
"canceled_notes": "No cumple con las políticas",
"created_at": "2018-05-02",
"updated_at": "2018-05-02"
}
],
"pagination": {
"cursors": {
"after": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"next_uri": "/crowdfunding/crowdfunds?cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8"
}
},
"links": [
{
"rel": "self",
"uri": "/crowdfunding/crowdfunds"
}
]
}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 de la Campaña de fondos"
},
"source_type": {
"type": "string",
"description": "Modelo que representa como la Campaña de fondos"
},
"source_id": {
"type": "string",
"description": "ID del modelo que representa como la Campaña de fondos"
},
"amount_cents": {
"type": "number",
"description": "Mónto que se necesita para fondear la Campaña"
},
"collected_amount_cents": {
"type": "number",
"description": "Mónto recaudado de la Campaña"
},
"status": {
"type": "string",
"description": "Estatus en la que se encuentra la Campaña de fondos"
},
"expiration_date": {
"type": "string",
"description": "Fecha que expiro la Campaña de fondos"
},
"success_percentage": {
"type": "string",
"description": "Porcentaje mínima a recaudar de la Campaña de fondos"
},
"funds_without_limit": {
"type": "boolean",
"description": "Fondeo sin límite de la Campaña de fondos"
},
"campaign_days": {
"type": "number",
"description": "Días de campaña de la Campaña de fondos"
},
"funded_at": {
"type": "string",
"description": "Fecha que termino de fondearse la Campaña de fondos"
},
"canceled_at": {
"type": "string",
"description": "Fecha que se cancelo la Campaña de fondos"
},
"canceled_notes": {
"type": "string",
"description": "Notas de la cancelación de la Campaña de fondos"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Campaña de Fondos"
},
"updated_at": {
"type": "string",
"description": "Última modificación de la Campaña de Fondos"
}
},
"required": [
"id",
"source_type",
"source_id",
"amount_cents",
"collected_amount_cents",
"status",
"expiration_date",
"success_percentage",
"campaign_days",
"created_at",
"updated_at"
]
},
"description": "Campaña de fondos"
},
"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 Campañas de FondosGET/crowdfunding/crowdfunds{?cursor}
La obtención de la lista de las Campañas de Fondos es una acción paginada. Se puede pasar el parámetro opcional cursor para obtener la siguiente página de las Campañas de Fondos. Esta ruta siempre regresará 20 Campañas de Fondos por página.
Puedes utilizar algunos de los siguientes parámetros como filtros:
| Parámetro | Tipo de filtro | Descripción |
|---|---|---|
by_amount_cents |
Entero | Filtra por total del monto solicitado para fonder la campaña |
by_collected_amount_cents |
Entero | Filtra por total del monto recaudado |
by_created_at |
Rango de fecha | Filtra por fecha de creación |
by_updated_at |
Rango de fecha | Filtra por fecha de última modificación |
URI Parameters
- cursor
string(required) Example: 5a36f715-1815-453e-81c5-68d0d1f96bc8Referencia del Cursor utilizado para paginar.
POST https://staging.creditar.io/crowdfunding/crowdfunds
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"source_type": "Project",
"source_id": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"amount_cents": 200000000,
"success_percentage": "80",
"funds_without_limit": true,
"campaign_days": 10
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"source_type": {
"type": "string",
"description": "Modelo que representa como la Campaña de fondos"
},
"source_id": {
"type": "string",
"description": "ID del modelo que representa como la Campaña de fondos"
},
"amount_cents": {
"type": "number",
"description": "Mónto que se necesita para fondear la Campaña"
},
"success_percentage": {
"type": "string",
"description": "Porcentaje mínima a recaudar de la Campaña de fondos"
},
"funds_without_limit": {
"type": "boolean",
"description": "Fondeo sin límite de la Campaña de fondos"
},
"campaign_days": {
"type": "number",
"description": "Días de campaña de la Campaña de fondos"
}
},
"required": [
"source_type",
"source_id",
"amount_cents",
"success_percentage",
"funds_without_limit",
"campaign_days"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": "868eca1c-9a1e-4d0d-a35a-3e5e47c52421",
"source_type": "Project",
"source_id": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"amount_cents": 200000000,
"collected_amount_cents": 2000000,
"status": "funded",
"expiration_date": "2019-07-08",
"success_percentage": "80",
"funds_without_limit": true,
"campaign_days": 10,
"funded_at": "2019-07-07",
"canceled_at": "2019-07-05",
"canceled_notes": "No cumple con las políticas",
"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": {
"id": {
"type": "string",
"description": "ID único de la Campaña de fondos"
},
"source_type": {
"type": "string",
"description": "Modelo que representa como la Campaña de fondos"
},
"source_id": {
"type": "string",
"description": "ID del modelo que representa como la Campaña de fondos"
},
"amount_cents": {
"type": "number",
"description": "Mónto que se necesita para fondear la Campaña"
},
"collected_amount_cents": {
"type": "number",
"description": "Mónto recaudado de la Campaña"
},
"status": {
"type": "string",
"description": "Estatus en la que se encuentra la Campaña de fondos"
},
"expiration_date": {
"type": "string",
"description": "Fecha que expiro la Campaña de fondos"
},
"success_percentage": {
"type": "string",
"description": "Porcentaje mínima a recaudar de la Campaña de fondos"
},
"funds_without_limit": {
"type": "boolean",
"description": "Fondeo sin límite de la Campaña de fondos"
},
"campaign_days": {
"type": "number",
"description": "Días de campaña de la Campaña de fondos"
},
"funded_at": {
"type": "string",
"description": "Fecha que termino de fondearse la Campaña de fondos"
},
"canceled_at": {
"type": "string",
"description": "Fecha que se cancelo la Campaña de fondos"
},
"canceled_notes": {
"type": "string",
"description": "Notas de la cancelación de la Campaña de fondos"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Campaña de Fondos"
},
"updated_at": {
"type": "string",
"description": "Última modificación de la Campaña de Fondos"
}
},
"required": [
"id",
"source_type",
"source_id",
"amount_cents",
"collected_amount_cents",
"status",
"expiration_date",
"success_percentage",
"campaign_days",
"created_at",
"updated_at"
]
},
"description": "Campaña de fondos"
}
},
"required": [
"data"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "invalid",
"code": "ERR-500",
"message": "El recurso no existe",
"href": "api/documentation#err-500"
}
]
}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 Campaña de FondosPOST/crowdfunding/crowdfunds
Crea una nueva Campaña de Fondos. Recibe un objeto de JSON con los parámetros de una Campaña de Fondos.
Campaña de fondos ¶
GET https://staging.creditar.io/crowdfunding/crowdfunds/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": "868eca1c-9a1e-4d0d-a35a-3e5e47c52421",
"source_type": "Project",
"source_id": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"amount_cents": 200000000,
"collected_amount_cents": 2000000,
"status": "funded",
"expiration_date": "2019-07-08",
"success_percentage": "80",
"funds_without_limit": true,
"campaign_days": 10,
"funded_at": "2019-07-07",
"canceled_at": "2019-07-05",
"canceled_notes": "No cumple con las políticas",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"funds": [
{
"id": "962ec05d-eb39-4246-ac5d-120139b9d28f"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/crowdfunding/crowdfunds/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 de la Campaña de fondos"
},
"source_type": {
"type": "string",
"description": "Modelo que representa como la Campaña de fondos"
},
"source_id": {
"type": "string",
"description": "ID del modelo que representa como la Campaña de fondos"
},
"amount_cents": {
"type": "number",
"description": "Mónto que se necesita para fondear la Campaña"
},
"collected_amount_cents": {
"type": "number",
"description": "Mónto recaudado de la Campaña"
},
"status": {
"type": "string",
"description": "Estatus en la que se encuentra la Campaña de fondos"
},
"expiration_date": {
"type": "string",
"description": "Fecha que expiro la Campaña de fondos"
},
"success_percentage": {
"type": "string",
"description": "Porcentaje mínima a recaudar de la Campaña de fondos"
},
"funds_without_limit": {
"type": "boolean",
"description": "Fondeo sin límite de la Campaña de fondos"
},
"campaign_days": {
"type": "number",
"description": "Días de campaña de la Campaña de fondos"
},
"funded_at": {
"type": "string",
"description": "Fecha que termino de fondearse la Campaña de fondos"
},
"canceled_at": {
"type": "string",
"description": "Fecha que se cancelo la Campaña de fondos"
},
"canceled_notes": {
"type": "string",
"description": "Notas de la cancelación de la Campaña de fondos"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Campaña de Fondos"
},
"updated_at": {
"type": "string",
"description": "Última modificación de la Campaña de Fondos"
},
"funds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Fondo"
}
},
"required": [
"id"
]
}
}
},
"required": [
"id",
"source_type",
"source_id",
"amount_cents",
"collected_amount_cents",
"status",
"expiration_date",
"success_percentage",
"campaign_days",
"created_at",
"updated_at",
"funds"
]
},
"description": "Fondos"
},
"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": "/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": [
{
"id": "868eca1c-9a1e-4d0d-a35a-3e5e47c52421",
"source_type": "Project",
"source_id": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"amount_cents": 200000000,
"collected_amount_cents": 2000000,
"status": "funded",
"expiration_date": "2019-07-08",
"success_percentage": "80",
"funds_without_limit": true,
"campaign_days": 10,
"funded_at": "2019-07-07",
"canceled_at": "2019-07-05",
"canceled_notes": "No cumple con las políticas",
"created_at": "2018-05-02",
"updated_at": "2018-05-02",
"funds": [
{
"id": "ba8f7f4a-239f-423e-9ff5-a783ec554f10",
"investor_id": "ac562154-06f5-4c3c-9cc8-864665de0532",
"crowdfund_id": "df5edf93-6973-401e-a8c4-ac440f30c804",
"amount_cents": 200000,
"paid_amount_cents": 1000,
"missing_amount_cents": 300000,
"status": "funding",
"i18n_status": "En préstamo",
"created_at": "2018-05-02",
"updated_at": "2018-05-02"
}
]
}
],
"links": [
{
"rel": "self",
"uri": "/crowdfunds/868eca1c-9a1e-4d0d-a35a-3e5e47c52421"
},
{
"id": "962ec05d-eb39-4246-ac5d-120139b9d28f",
"rel": "fund",
"uri": "/funds/962ec05d-eb39-4246-ac5d-120139b9d28f"
}
]
}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 de la Campaña de fondos"
},
"source_type": {
"type": "string",
"description": "Modelo que representa como la Campaña de fondos"
},
"source_id": {
"type": "string",
"description": "ID del modelo que representa como la Campaña de fondos"
},
"amount_cents": {
"type": "number",
"description": "Mónto que se necesita para fondear la Campaña"
},
"collected_amount_cents": {
"type": "number",
"description": "Mónto recaudado de la Campaña"
},
"status": {
"type": "string",
"description": "Estatus en la que se encuentra la Campaña de fondos"
},
"expiration_date": {
"type": "string",
"description": "Fecha que expiro la Campaña de fondos"
},
"success_percentage": {
"type": "string",
"description": "Porcentaje mínima a recaudar de la Campaña de fondos"
},
"funds_without_limit": {
"type": "boolean",
"description": "Fondeo sin límite de la Campaña de fondos"
},
"campaign_days": {
"type": "number",
"description": "Días de campaña de la Campaña de fondos"
},
"funded_at": {
"type": "string",
"description": "Fecha que termino de fondearse la Campaña de fondos"
},
"canceled_at": {
"type": "string",
"description": "Fecha que se cancelo la Campaña de fondos"
},
"canceled_notes": {
"type": "string",
"description": "Notas de la cancelación de la Campaña de fondos"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación de la Campaña de Fondos"
},
"updated_at": {
"type": "string",
"description": "Última modificación de la Campaña de Fondos"
},
"funds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID único del Fondo"
},
"investor_id": {
"type": "string",
"description": "ID único del Inversionista"
},
"crowdfund_id": {
"type": "string",
"description": "ID único de la Campaña de Fondos"
},
"amount_cents": {
"type": "number",
"description": "Mónto del Fondo en centavos"
},
"paid_amount_cents": {
"type": "number",
"description": "Mónto pagado del Fondo en centavos"
},
"missing_amount_cents": {
"type": "number",
"description": "Mónto faltante por pagar del Fondo en centavos"
},
"status": {
"type": "string",
"description": "Estatus del Fondo"
},
"i18n_status": {
"type": "string",
"description": "Traducción del estadus del fondo"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Fondo"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Fondo"
}
},
"required": [
"id",
"investor_id",
"crowdfund_id",
"amount_cents",
"status",
"i18n_status",
"created_at",
"updated_at"
]
}
}
},
"required": [
"id",
"source_type",
"source_id",
"amount_cents",
"collected_amount_cents",
"status",
"expiration_date",
"success_percentage",
"campaign_days",
"created_at",
"updated_at",
"funds"
]
},
"description": "Fondos"
},
"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"
]
}
],
"description": "Links a referencias"
}
},
"required": [
"data",
"links"
]
}Obtener una Campaña de fondosGET/crowdfunding/crowdfunds/{id}
Obtiene una sola Campaña de fondos. Cuando se utiliza el parámetro include, los recursos relacionados son incluidos.
Los valores válidos para el parámetro de include son fund. Los valores deben ir separados por coma y sin espacios.
URI Parameters
- id
string(required) Example: 6313ac69-dc0d-45a8-8804-4ac451e1db5cidde la Campaña de fondos a obtener
Inversionistas ¶
Un inversionista es la representación de un Cliente
Inversionistas ¶
Esta ruta solo listara los Inversionistas.
GET https://staging.creditar.io/crowdfunding/investors?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": "ae66de66-5187-4c5e-b53b-63da817ee998",
"investorable_type": "Customer",
"investorable_id": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"blocked": false,
"active": true,
"email": "bojack@horseman.io",
"first_name": "Bojack",
"second_name": "Harman",
"last_name": "Horseman",
"mother_name": "Chulte",
"rfc": "BOJA1234",
"curp": "BOJA1234567",
"clabe": "1234567890",
"official_id": "https://staging.creditar.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--19f8c22c36866305fa3878fe3a04e19a0fc6f4d1/WhatsApp%20Image%202018-03-06%20at%208.24.22%20PM.pdf",
"invested_amount_cents": 20000,
"available_balance_amount_cents": 10000,
"signed_contract_at": "2018-05-04",
"created_at": "2018-05-02",
"updated_at": "2018-05-02"
}
],
"pagination": {
"cursors": {
"after": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"next_uri": "/crowdfunding/investors?cursor=5a36f715-1815-453e-81c5-68d0d1f96bc8"
}
},
"links": [
{
"rel": "self",
"uri": "/crowdfunding/investors"
}
]
}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 Inversionista"
},
"investorable_type": {
"type": "string",
"description": "Modelo que representa la cuenta del Inversionista"
},
"investorable_id": {
"type": "string",
"description": "ID del de la cuenta del Inversionista"
},
"blocked": {
"type": "boolean",
"description": "Estado del bloqueo del Inversionista"
},
"active": {
"type": "boolean",
"description": "Estado del activo del Inversionista"
},
"email": {
"type": "string",
"description": "Correo electrónico del inversionista"
},
"first_name": {
"type": "string",
"description": "Nombre del Inversionista"
},
"second_name": {
"type": "string",
"description": "Segundo nombre del Inversionista"
},
"last_name": {
"type": "string",
"description": "Apellido paterno del Inversionista"
},
"mother_name": {
"type": "string",
"description": "Apellido materno del Inversionista"
},
"rfc": {
"type": "string",
"description": "RFC del inversionista"
},
"curp": {
"type": "string",
"description": "CURP del inversionista"
},
"clabe": {
"type": "string",
"description": "CLABE del inversionista"
},
"official_id": {
"type": "string",
"description": "URL del documento oficial"
},
"invested_amount_cents": {
"type": "number",
"description": "Mónto invertido en Campaña de fondos en centavos"
},
"available_balance_amount_cents": {
"type": "number",
"description": "Mónto disponible para invertir en centavos"
},
"signed_contract_at": {
"type": "string",
"description": "Fecha de la firma del contrato del Inversionista"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Inversionista"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Inversionista"
}
},
"required": [
"id",
"investorable_type",
"investorable_id",
"created_at",
"updated_at"
]
},
"description": "Inversionista"
},
"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 InversionistasGET/crowdfunding/investors{?cursor}
La obtención de la lista de Inversionistas activos es una acción paginada. Se puede pasar el parámetro opcional cursor para obtener la siguiente página de Inversionistas. Esta ruta siempre regresará 20 Inversionistas por página.
Puedes utilizar algunos de los siguientes parámetros como filtros:
| Parámetro | Tipo de filtro | Descripción |
|---|---|---|
by_available_balance_amount_cents |
Entero | Filtra por monto disponible para fondear |
by_invested_amount_cents |
Entero | Filtra por monto fondeado en campañas |
by_created_at |
Rango de fecha | Filtra por fecha de creación |
by_updated_at |
Rango de fecha | Filtra por fecha de última modificación |
URI Parameters
- cursor
string(required) Example: 5a36f715-1815-453e-81c5-68d0d1f96bc8Referencia del Cursor utilizado para paginar.
POST https://staging.creditar.io/crowdfunding/investors
Requests
Headers
Content-Type: application/json
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeBody
{
"investorable_type": "Customer",
"investorable_id": "5a36f715-1815-453e-81c5-68d0d1f96bc8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"investorable_type": {
"type": "string",
"description": "Modelo que representa el Cliente que sera Inversionista"
},
"investorable_id": {
"type": "string",
"description": "ID del Cliente que sera Inversionista"
}
},
"required": [
"investorable_type",
"investorable_id"
]
}Responses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": "ae66de66-5187-4c5e-b53b-63da817ee998",
"investorable_type": "Customer",
"investorable_id": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"blocked": false,
"active": true,
"email": "bojack@horseman.io",
"first_name": "Bojack",
"second_name": "Harman",
"last_name": "Horseman",
"mother_name": "Chulte",
"rfc": "BOJA1234",
"curp": "BOJA1234567",
"clabe": "1234567890",
"official_id": "https://staging.creditar.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--19f8c22c36866305fa3878fe3a04e19a0fc6f4d1/WhatsApp%20Image%202018-03-06%20at%208.24.22%20PM.pdf",
"invested_amount_cents": 20000,
"available_balance_amount_cents": 10000,
"signed_contract_at": "2018-05-04",
"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": {
"id": {
"type": "string",
"description": "ID único del Inversionista"
},
"investorable_type": {
"type": "string",
"description": "Modelo que representa la cuenta del Inversionista"
},
"investorable_id": {
"type": "string",
"description": "ID del de la cuenta del Inversionista"
},
"blocked": {
"type": "boolean",
"description": "Estado del bloqueo del Inversionista"
},
"active": {
"type": "boolean",
"description": "Estado del activo del Inversionista"
},
"email": {
"type": "string",
"description": "Correo electrónico del inversionista"
},
"first_name": {
"type": "string",
"description": "Nombre del Inversionista"
},
"second_name": {
"type": "string",
"description": "Segundo nombre del Inversionista"
},
"last_name": {
"type": "string",
"description": "Apellido paterno del Inversionista"
},
"mother_name": {
"type": "string",
"description": "Apellido materno del Inversionista"
},
"rfc": {
"type": "string",
"description": "RFC del inversionista"
},
"curp": {
"type": "string",
"description": "CURP del inversionista"
},
"clabe": {
"type": "string",
"description": "CLABE del inversionista"
},
"official_id": {
"type": "string",
"description": "URL del documento oficial"
},
"invested_amount_cents": {
"type": "number",
"description": "Mónto invertido en Campaña de fondos en centavos"
},
"available_balance_amount_cents": {
"type": "number",
"description": "Mónto disponible para invertir en centavos"
},
"signed_contract_at": {
"type": "string",
"description": "Fecha de la firma del contrato del Inversionista"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Inversionista"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Inversionista"
}
},
"required": [
"id",
"investorable_type",
"investorable_id",
"created_at",
"updated_at"
]
},
"description": "Inversionista"
}
},
"required": [
"data"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "invalid",
"code": "ERR-500",
"message": "La cuenta del usuario no existe",
"href": "api/documentation#err-500"
}
]
}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 InversionistaPOST/crowdfunding/investors
Crea un nuevo Inversionista con la referencia de Cliente. Recibe un objeto de JSON con los parámetros de un Inversionista.
PATCH https://staging.creditar.io/crowdfunding/investors
Requests
Headers
Content-Type: multipart/form-data
Accept: application/vnd.creditar.v1+json
Authorization: Token token=BMBE96Wva8NaYMmVx4RavpXSy6Y6HKFeResponses
Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": "ae66de66-5187-4c5e-b53b-63da817ee998",
"investorable_type": "Customer",
"investorable_id": "5a36f715-1815-453e-81c5-68d0d1f96bc8",
"blocked": false,
"active": true,
"email": "bojack@horseman.io",
"first_name": "Bojack",
"second_name": "Harman",
"last_name": "Horseman",
"mother_name": "Chulte",
"rfc": "BOJA1234",
"curp": "BOJA1234567",
"clabe": "1234567890",
"official_id": "https://staging.creditar.io/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--19f8c22c36866305fa3878fe3a04e19a0fc6f4d1/WhatsApp%20Image%202018-03-06%20at%208.24.22%20PM.pdf",
"invested_amount_cents": 20000,
"available_balance_amount_cents": 10000,
"signed_contract_at": "2018-05-04",
"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": {
"id": {
"type": "string",
"description": "ID único del Inversionista"
},
"investorable_type": {
"type": "string",
"description": "Modelo que representa la cuenta del Inversionista"
},
"investorable_id": {
"type": "string",
"description": "ID del de la cuenta del Inversionista"
},
"blocked": {
"type": "boolean",
"description": "Estado del bloqueo del Inversionista"
},
"active": {
"type": "boolean",
"description": "Estado del activo del Inversionista"
},
"email": {
"type": "string",
"description": "Correo electrónico del inversionista"
},
"first_name": {
"type": "string",
"description": "Nombre del Inversionista"
},
"second_name": {
"type": "string",
"description": "Segundo nombre del Inversionista"
},
"last_name": {
"type": "string",
"description": "Apellido paterno del Inversionista"
},
"mother_name": {
"type": "string",
"description": "Apellido materno del Inversionista"
},
"rfc": {
"type": "string",
"description": "RFC del inversionista"
},
"curp": {
"type": "string",
"description": "CURP del inversionista"
},
"clabe": {
"type": "string",
"description": "CLABE del inversionista"
},
"official_id": {
"type": "string",
"description": "URL del documento oficial"
},
"invested_amount_cents": {
"type": "number",
"description": "Mónto invertido en Campaña de fondos en centavos"
},
"available_balance_amount_cents": {
"type": "number",
"description": "Mónto disponible para invertir en centavos"
},
"signed_contract_at": {
"type": "string",
"description": "Fecha de la firma del contrato del Inversionista"
},
"created_at": {
"type": "string",
"description": "Fecha de Creación del Inversionista"
},
"updated_at": {
"type": "string",
"description": "Última modificación del Inversionista"
}
},
"required": [
"id",
"investorable_type",
"investorable_id",
"created_at",
"updated_at"
]
},
"description": "Inversionista"
}
},
"required": [
"data"
]
}Headers
Content-Type: application/jsonBody
{
"errors": [
{
"type": "invalid",
"code": "ERR-500",
"message": "La fecha de firma del contrato debe ser igual o mayor a la fecha actual",
"href": "api/documentation#err-"
}
]
}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 InversionistaPATCH/crowdfunding/investors
Actualiza un Inversionista. A diferencia de las demas rutas esta no recibe ningún JSON, sino un mensaje de tipo multipart/form-data.
El mensaje deberá incluir los siguientes campos:
| Campo | Descripción |
|---|---|
| first_name | Primer nombre del inversionista. |
| second_name | Segundo nombre del inversionista. |
| last_name | Apellido paterno del inversionista. |
| mother_name | Apellido materno del inversionista. |
| rfc | RFC del inversionista. |
| curp | CURP del inversionista. |
| clabe | CLABE interbancaria del inversionista. |
| blocked | Bloqueo del inversionista. |
| official_id | Documento de identidad oficial del inversionista. Representa el archivo que se subirán los formatos aceptados son GIF, TIFF, PNG, JPG/JPEG y PDF; el tamaño del archivo debe ser menor a 7 MB. |
| signed_contract_at | Fecha de firma del contrato del inversionista. |
Nota: Para poder activar un Inversionista desde la API es primero actualizar el Documento de identidad oficial y después definir la Fecha de firma de contrato.
Inversionista ¶
GET https://staging.creditar.io/crowdfunding/investors/6313ac69-dc0d-45a8-8804-4ac451e1db5c?include=contract,fund,movement
Requests
Headers
Content-Type: application/