Skip to content

Listar todas las órdenes del crédito

GET
/payables/{creditid}/orders

Retorna el historial de todas las órdenes de pago asociadas al crédito,
incluyendo pagos completados, pendientes y fallidos.

Authorizations

bearerAuth

JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.

TypeHTTP (bearer)

Parameters

Path Parameters

creditid*

ID único del crédito

Typestring
Required
Example123e4567-e89b-12d3-a456-426614174000
formatuuid

Query Parameters

status

Filtrar órdenes por estado

Typestring
Enum
pendingcompletedfailedcancelledprocessing
Examplecompleted
limit

Número máximo de órdenes a retornar

Typeinteger
Example20
minimum1
maximum100
default50
offset

Número de órdenes a omitir (para paginación)

Typeinteger
Example0
minimum0
default0
startDate

Fecha de inicio para filtrar órdenes (ISO 8601)

Typestring
Example2024-01-01
formatdate
endDate

Fecha de fin para filtrar órdenes (ISO 8601)

Typestring
Example2024-01-31
formatdate

Responses

Lista de órdenes de pago obtenida exitosamente
application/json
JSON
{
"orders": [
{
"ID": "123e4567-e89b-12d3-a456-426614174010",
"CreditID": "123e4567-e89b-12d3-a456-426614174000",
"InstallmentID": "123e4567-e89b-12d3-a456-426614174001",
"InstallmentNumber": 3,
"Amount": "125000.00",
"Type": "payment",
"Provider": "payvalida",
"Status": "completed",
"Method": "credit_card",
"CreatedAt": "2024-01-15T10:30:00Z",
"CompletedAt": "2024-01-15T11:00:00Z",
"CreatorID": "123e4567-e89b-12d3-a456-426614174015",
"ApproverID": "123e4567-e89b-12d3-a456-426614174016",
"CollectionCosts": "5000.00",
"TransactionReference": "TXN-20240115-001",
"ErrorMessage": ""
}
],
"pagination": {
"total": 45,
"count": 20,
"limit": 20,
"offset": 0,
"hasNext": true,
"hasPrevious": false
},
"summary": {
"totalAmount": "2500000.00",
"completedAmount": "2125000.00",
"pendingAmount": "375000.00",
"statusCounts": {
"completed": 38,
"pending": 5,
"failed": 2,
"cancelled": 0
}
}
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI