Mono Colombia
GuíasReferencia de API

Lists programs

Lists your programs, newest first. The order is deterministic — id breaks ties between programs created at the same instant — so paging through a list that does not change between requests never repeats or skips a program.

Filters combine with AND: features and supported_currencies each require a program to satisfy every value passed, and the per-field text filters narrow further. The one exception is search, which matches name or description, and still ANDs against everything else. Filtering does not go below the feature level — there is no filter by method or by configuration value.

An account with no programs receives an empty page, not an error.

GET
/v1/core/programs

Autorización

AutorizaciónBearer <token>

En: header

Parámetros de consulta

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
features?array<string>|string

Only programs with all of these features enabled.

supported_currencies?array<string>|string

Only programs supporting all of these currencies.

search?string

Free-text search across name and description: a program matches when either contains the value. This is the only filter that is an OR; it still ANDs against every other filter.

It ignores case but not accents, and matches the value literally — %, _ and \ are plain characters — like the per-field text filters. A program with no description can still match on its name. Whitespace is not trimmed, so a value of " " matches every program whose name or description contains a space; trim before sending.

Length1 <= length
Example"dropi"
name?object

Filter by the program's name

Properties1 <= properties <= 1
description?object

Filter by the program's description

Properties1 <= properties <= 1

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.sandbox.cuentamono.com/v1/core/programs"
{
  "pagination": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 100,
    "total_pages": 10
  },
  "programs": [
    {
      "default": true,
      "description": "Operación principal en pesos",
      "features": {
        "cards": {
          "configuration": {
            "issuance": {
              "allowed_document_countries": [
                "CO"
              ],
              "enabled": true
            },
            "operation_country": "CO",
            "transactions": {
              "enabled": true
            }
          },
          "enabled": true
        },
        "ledger": {
          "configuration": {
            "account_to_account_fx": {
              "enabled": true
            }
          },
          "enabled": true
        },
        "payins": {
          "configuration": {
            "methods": {
              "co_breb": {
                "currencies": [
                  "COP"
                ],
                "enabled": true,
                "key_naming": {
                  "custom_value_max_length": 12,
                  "custom_value_min_length": 5,
                  "merchant_prefix": "MONO - ",
                  "value_prefix": "MN"
                },
                "qr_config": {
                  "merchant_category_code": "5411",
                  "receiver_city": "BOGOTA",
                  "receiver_postal_code": "110111"
                }
              }
            }
          },
          "enabled": true
        },
        "payouts": {
          "configuration": {
            "methods": {
              "co_ach": {
                "currencies": {
                  "COP": [
                    "CO"
                  ]
                },
                "enabled": true
              },
              "co_breb": {
                "allow_custom_payer_name": true,
                "currencies": {
                  "COP": [
                    "CO"
                  ]
                },
                "enabled": true,
                "payer_name": "Mono Colombia S.A.S"
              },
              "co_mono_turbo": {
                "currencies": {
                  "COP": [
                    "CO"
                  ]
                },
                "enabled": true
              },
              "co_transfiya": {
                "currencies": {
                  "COP": [
                    "CO"
                  ]
                },
                "enabled": true
              }
            }
          },
          "enabled": true
        }
      },
      "id": "pro_5tgliBmzjZ6mpQPRbQjfKj",
      "inserted_at": "2022-01-01T01:00:00Z",
      "name": "Programa principal COP",
      "supported_currencies": [
        "COP"
      ],
      "updated_at": "2022-01-01T01:00:00Z"
    }
  ]
}
{
  "code": "400 Bad Request",
  "errors": [
    {
      "error_code": "validation_error",
      "message": "Generic changeset errors",
      "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": "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"
}