Mono Colombia
GuidesAPI reference

Lists settlement batches

Lists the requesting client's settlement batches, paginated. Results are ordered by creation date descending (newest first) unless sort is provided, and can be narrowed with the filters below.

A row reports how many payins the batch settles; fetch the batch by its ID to see them.

GET
/v1/core/payins/settlement_batches

Authorization

authorization
AuthorizationBearer <token>

In: header

Query Parameters

page_number?integer

Number of the page

Default1
Range1 <= value
Example1
page_size?integer

Amount of registers that must be listed by page

Default10
Range10 <= value <= 500
Example10
sort?object

Sort order (defaults to newest first by creation date)

Default{"field":"inserted_at","type":"desc"}
state?string

Filter by settlement batch state

Value in"created" | "processing" | "completed" | "retryable" | "failed"
method?string

Filter by settlement method

Value in"co_breb" | "internal_transfer"
funding_account_id?string

Filter by the funding account the batch credits

Match^[A-Za-z]{2,7}_[\w-]{22}$
Example"facc_5tgliBmzjZ6mpQPRbQjfKj"
inserted_at?object

Filter the batches by creation date and time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.sandbox.cuentamono.com/v1/core/payins/settlement_batches"
{
  "pagination": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 100,
    "total_pages": 10
  },
  "settlement_batches": [
    {
      "funding_account_id": "facc_5tgliBmzjZ6mpQPRbQjfKj",
      "id": "cpisb_5tgliBmzjZ6mpQPRbQjfKj",
      "inserted_at": "2022-01-01T01:00:00Z",
      "method": "co_breb",
      "state": "created",
      "total_amount": {
        "amount": 1100000000,
        "currency": "COP"
      },
      "updated_at": "2022-01-01T01:00:00Z",
      "payins_count": 37
    }
  ]
}
{
  "code": "401 Unauthorized",
  "errors": [
    {
      "error_code": "missing_authorization_header",
      "message": "`Authorization` header is missing.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Authorization header is missing or invalid."
}
{
  "code": "403 Forbidden",
  "errors": [
    {
      "error_code": "not_authorized",
      "message": "Not authorized to have access to this resource.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Not authorized to have access to this resource"
}
{
  "code": "422 Unprocessable Content",
  "errors": [
    {
      "error_code": "invalid_enum",
      "message": "The field contains an invalid value.",
      "path": "#/path/to/field",
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Validation errors"
}