Mono Colombia
GuidesAPI reference

Lists templates

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

GET
/v1/core/payins/templates

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"}
expires_at?object

Filter by expiration timestamp range

inserted_at?object

Filter by creation timestamp range

enabled?boolean

Filter by enabled status

Exampletrue
external_id?string

Filter by tenant-side identifier

Length1 <= length <= 255
Example"string"
reference?string

Filter by payer reference

Length3 <= length
Example"string"
custom_merchant_name?string

Filter by merchant name shown to the payer

Length1 <= length
Example"string"
nickname?string

Filter by template nickname

Length1 <= length
Example"string"
subaccount_id?string

Filter by subaccount that owns the template

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

Filter by usage mode

Value in"single_use" | "multiple_use"
Example"single_use"
metadata?object

Filter by template metadata key-value pairs

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.sandbox.cuentamono.com/v1/core/payins/templates"
{
  "pagination": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 100,
    "total_pages": 10
  },
  "templates": [
    {
      "reference": "Invoice #0042",
      "maximum_payin_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "prune_reason": null,
      "inserted_at": "2022-01-01T01:00:00Z",
      "payin_data": {
        "fee_override": [
          {
            "fixed": {
              "amount": 100000000,
              "currency": "COP"
            },
            "percentage": "0.05",
            "tx_description": "Collection service fee",
            "type": "payin"
          }
        ],
        "metadata": {
          "id": 3,
          "reference": 123
        },
        "redirect_url": "https://merchant.example.com/checkout/return",
        "subaccount_disbursement_trigger": "on_approval"
      },
      "type": "collection",
      "minimum_payin_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "total_maximum_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "payment_tokens": {
        "co_breb": {
          "key_type": "alphanumeric",
          "key_value": "@MN1A2B3C4D5E",
          "qr": {
            "amount": {
              "amount": 100000000,
              "currency": "COP"
            },
            "emvco": "00020101021226440014CO.COM.CRB.RED0122CO.COM.CRB.TRXIDP123456752045411530317054061000005802CO5910Acme Store6006Bogota6304A1B2",
            "error_correction_level": "medium",
            "expires_at": "2022-01-01T01:00:00Z",
            "image": "iVBORw0KGgoAAAANSUhEUgAABAAAAAQACAYAAAB...",
            "image_width": 512,
            "payment_id": "CO.COM.CRB.TRXIDP1234567891234",
            "usage_mode": "multiple_use"
          },
          "qr_error": null
        }
      },
      "state_reason": null,
      "total_minimum_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "expires_at": "2022-01-01T01:00:00Z",
      "usage_mode": "single_use",
      "checkout_url": "https://www.mono.la/",
      "updated_at": "2022-01-01T01:00:00Z",
      "id": "cpitpl_5tgliBmzjZ6mpQPRbQjfKj",
      "subaccount_id": "lacc_5tgliBmzjZ6mpQPRbQjfKj",
      "pruned_at": "2022-01-01T01:00:00Z",
      "prune_state": null,
      "currency": "COP",
      "enabled": false,
      "expected_payers": [
        {
          "document_number": "1023711432",
          "document_type": "CC",
          "kind": "co_person_document"
        }
      ],
      "paid_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "external_id": "invoice-2026-0042",
      "method_params": {
        "co_breb": {
          "create_qr": false,
          "custom_key_value": "@MYSTORE01",
          "key_per": "template",
          "qr_code_data": {
            "merchant_category_code": "5411",
            "receiver_city": "Bogota",
            "receiver_postal_code": "110111"
          }
        }
      },
      "nickname": "Monthly rent - Apt 101",
      "custom_merchant_name": "Acme Store",
      "state": "ready",
      "failed_payins": 1,
      "successful_payins": 1,
      "metadata": {
        "id": 3,
        "reference": 123
      },
      "form_customization": {
        "brand_id": "cpitplb_5tgliBmzjZ6mpQPRbQjfKj",
        "custom_fields": [
          {
            "default_value": "ORD-1042",
            "description": "The one on the invoice, without dashes.",
            "editable": true,
            "label": "Order number",
            "required": false,
            "type": "text"
          }
        ]
      },
      "expires_in": 1,
      "available_methods": [
        "co_breb"
      ]
    }
  ]
}
{
  "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"
}