List collections

Lists collections with pagination and filtering.

Authorization

AuthorizationBearer <token>

In: header

Scope: collections:readonly

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

Sorts the collections according to the types and fields.

Default{"field":"inserted_at","type":"desc"}

inserted_at?object

Filter by inserted_at field, it works as with range of date/time.

expires_at?object

Filter by expires_at field, it works as with range of date/time.

enabled?boolean

Filter by enabled field

external_id?string

Filter by external ID field

reference?string

Filter by reference field, it works as not exact filter and must be sent 3 characters at least.

Length3 <= length

custom_key_value?string

Filter by custom key value

Length1 <= length

custom_merchant_name?string

Filter by custom merchant name

Length1 <= length

nickname?string

Filter by nickname

Length1 <= length

tenant_account_id?string

Filter by tenant account ID

Match^[A-Za-z]{2,7}_[\w-]{22}$

Example"bbtacc_5tgliBmzjZ6mpQPRbQjfKj"

usage_mode?string

Filter by usage mode

Value in"single_use" | "multiple_use"

metadata?object

Filter by collection's metadata

Example

{
  "id": 3,
  "reference": 123
}

Response Body

`application/json`

curl -X GET "https://breb-participant.sandbox.mono.la/api/v1/collections"

curl -X GET "https://breb-participant.sandbox.mono.la/api/v1/collections"

{
  "collections": [
    {
      "custom_key_value": "INV12345",
      "custom_merchant_name": "Acme Corp",
      "enabled": true,
      "expected_payers": [
        {
          "document_number": "1234567890",
          "document_type": "CC"
        }
      ],
      "expires_at": "2022-01-01T01:00:00Z",
      "expires_in": 1,
      "external_id": "invoice-12345",
      "failed_attempts": 0,
      "id": "bbcol_5tgliBmzjZ6mpQPRbQjfKj",
      "inserted_at": "2022-01-01T01:00:00Z",
      "key_pruned_at": "2022-01-01T01:00:00Z",
      "keys": [
        {
          "name": "Acme Corp - INV12345",
          "state": "active",
          "type": "identification",
          "value": "@MONO1A2B3C4D5E"
        }
      ],
      "maximum_attempt_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "metadata": {
        "id": 3,
        "reference": 123
      },
      "minimum_attempt_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "nickname": "Monthly subscription",
      "paid_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "prune_status": null,
      "reference": "Payment for November 2025",
      "state": "created",
      "state_reason": null,
      "successful_attempts": 0,
      "tenant_account_id": "bbtacc_5tgliBmzjZ6mpQPRbQjfKj",
      "total_maximum_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "total_minimum_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "updated_at": "2022-01-01T01:00:00Z",
      "usage_mode": "single_use"
    }
  ],
  "pagination": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 100,
    "total_pages": 10
  }
}

{
  "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": "500 Internal Server Error",
  "errors": [
    {
      "error_code": "internal_error",
      "message": "An unexpected error occurred",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Something went wrong on the Server"
}

List collections

Authorization

Query Parameters

Response Body

200application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`