Mono Colombia

Get a collection by ID

Retrieves a specific collection by its ID.

GET
/api/v1/collections/{id}
AuthorizationBearer <token>

In: header

Scope: collections:readonly

Path Parameters

idstring

The collection ID

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://breb-participant.sandbox.mono.la/api/v1/collections/bbcol_5tgliBmzjZ6mpQPRbQjfKj"
{
  "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"
}
{
  "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": "404 Not Found",
  "errors": [
    {
      "error_code": "collection_not_found",
      "message": "The collection doesn't exist",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Resource not defined"
}
{
  "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"
}