Receivables - List
Lista recebíveis (valores a receber) com filtros de período e paginação para conciliação financeira.
Lista recebíveis (valores a receber) com filtros de período e paginação para conciliação financeira.
Authorization
SelectKeyAuth API key for all authenticated requests. Send your key in the selectkey header (e.g. sandbox sl_test_…, production sl_live_…).
In: header
Query Parameters
Maximum number of items to return
Number of items to skip
Sort order for results
Filter by release status (yes / no — converted in the list workflow)
Filter by receivable status
Filter by receivable ID
Filter to a single calendar day; the API expands this to the start and end of that day for the relevant timestamp field.
Lower bound (exclusive): include only records whose date field is strictly after this value.
Lower bound (inclusive): include only records whose date field is on or after this value.
Upper bound (exclusive): include only records whose date field is strictly before this value.
Upper bound (inclusive): include only records whose date field is on or before this value.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/receivables?limit=20&offset=0&sort=descending&released=yes&status=pending&id=rec_abc123&daterange=2026-01-01T00%3A00%3A00Z&daterangegt=2026-01-01T00%3A00%3A00Z&daterangegte=2026-01-01T00%3A00%3A00Z&daterangelt=2026-01-01T00%3A00%3A00Z&daterangelte=2026-01-01T00%3A00%3A00Z"{
"offset": 0,
"limit": 20,
"total": 128,
"page": {
"offset": {
"first": 0,
"prev": null,
"next": 20,
"last": 120
},
"current": 1,
"total": 7
},
"data": [
{
"id": "rec_01hqzvabc",
"transactionId": "tra_01hqzvabc",
"recipientId": null,
"splitId": null,
"currency": "BRL",
"amount": 4850,
"grossAmount": 5000,
"status": "pending",
"installmentNumber": 1,
"anticipationFee": 0,
"liable": true,
"chargeProcessingFee": true,
"description": "Payment successfully completed.",
"paidAt": null,
"refundedAt": null,
"canceledAt": null,
"expectedOn": "2026-04-20T00:00:00.000Z",
"updatedAt": "2026-04-12T17:56:33.000Z",
"createdAt": "2026-04-12T17:56:33.000Z"
}
],
"hasMore": true,
"merchant": {
"name": "Seller Name",
"merchantId": "bus_1234567890",
"isSubAccount": false
},
"_links": {
"self": {
"href": "https://api.selectwin.io/v1/receivables/list",
"method": "GET"
},
"analytics": {
"href": "https://api.selectwin.io/v1/receivables/analytics",
"method": "GET"
}
}
}{
"error": {
"status": "Bad Request",
"statusCode": 400,
"category": "validation",
"message": "Validation errors occurred",
"details": "One or more parameters are invalid or out of range. Please check the parameters and try again.",
"params": [
{
"payment[currency]": "currency must be one of [BRL]"
},
{
"amount": "amount is required"
}
],
"code": "invalidParameters",
"resource": "client"
}
}{
"error": {
"status": "Unauthorized",
"statusCode": 401,
"category": "authentication",
"message": "Unauthorized",
"details": "Authentication failed. The provided API key is invalid or does not have permission to operate.",
"code": "unauthorized"
}
}{
"error": {
"status": "Forbidden",
"statusCode": 403,
"category": "authorization",
"message": "Forbidden",
"details": "Access denied. This may be due to IP blocks, domain restrictions, or insufficient permissions.",
"code": "forbidden"
}
}{
"error": {
"status": "Not Found",
"statusCode": 404,
"category": "client",
"message": "Not Found",
"details": "The requested resource was not found on the server.",
"code": "notFound"
}
}{
"error": {
"status": "Unprocessable Entity",
"statusCode": 422,
"category": "validation",
"message": "Unprocessable Entity",
"details": "The request was understood, but contains invalid data that could not be processed.",
"code": "unprocessableEntity"
}
}{
"error": {
"status": "Too Many Requests",
"statusCode": 429,
"category": "rate_limit",
"message": "Too Many Requests",
"details": "The number of requests exceeded the limit allowed for the IP or user.",
"retryAfterMinutes": 60,
"code": "tooManyRequests"
}
}{
"error": {
"status": "Internal Server Error",
"statusCode": 500,
"category": "server",
"message": "Server error.",
"details": "An internal server error occurred. Please try again later.",
"code": "serverError",
"resource": "server"
}
}