Mono Colombia

Get a collection attempt by ID

Retrieves a specific collection attempt by its ID.

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

In: header

Scope: collections:readonly

Path Parameters

collection_idstring

The collection ID

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

The collection attempt ID

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://breb-participant.cert.monoban.co/api/v1/collections/bbcol_5tgliBmzjZ6mpQPRbQjfKj/attempts/bbcolat_5tgliBmzjZ6mpQPRbQjfKj"
{
  "amount": {
    "amount": 100000000,
    "currency": "COP"
  },
  "collection_id": "bbcol_5tgliBmzjZ6mpQPRbQjfKj",
  "end_to_end_id": "string",
  "id": "bbcolat_5tgliBmzjZ6mpQPRbQjfKj",
  "inserted_at": "2022-01-01T01:00:00Z",
  "key_type": "identification",
  "key_value": "string",
  "payer": {
    "document_number": "1234567890",
    "document_type": "CC",
    "full_name": "Juan Pérez",
    "type": "natural"
  },
  "payer_account": {
    "currency_code": "COP",
    "number": "1234567890",
    "type": "savings_account"
  },
  "state": "created",
  "state_reason": null,
  "tenant_account_id": "bbtacc_5tgliBmzjZ6mpQPRbQjfKj",
  "updated_at": "2022-01-01T01:00:00Z"
}
{
  "code": "400 Bad Request",
  "errors": [
    {
      "error_code": "collection_not_found",
      "message": "The collection doesn't exist",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Malformed request"
}
{
  "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_attempt_not_found",
      "message": "The collection attempt 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"
}