Mono Colombia
GuidesAPI reference

Lists payins

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

GET
/v1/core/payins

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"}
method?string

Filter by payment method

Value in"co_breb"
Example"co_breb"
state?string

Filter by payin state

Value in"created" | "awaiting_payment" | "approved_in_provider" | "subaccount_credited" | "rejected" | "failed"
Example"created"
subaccount_disbursement_trigger?string

Filter by distribution trigger

Value in"on_approval" | "on_funds_delivery" | "on_tenant_request"
Example"on_approval"
external_id?string

Filter by the parent intent's tenant-side identifier

Example"0ccea785-eec1-412a"
intent_id?string

Filter by parent intent

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

Filter by parent template

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

Filter by subaccount that owns the payin

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

Filter by funding account

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

Method-specific filters, namespaced by payment method (e.g. method_data[co_breb][recipient][key_value]).

metadata?object

Filter by payin 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"
{
  "pagination": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 100,
    "total_pages": 10
  },
  "payins": [
    {
      "instrument": {
        "data": {
          "currency_code": "COP",
          "number": "94628800123",
          "participant_nit": "890903938",
          "type": "savings_account"
        },
        "kind": "co_breb_account",
        "payer": {
          "data": {
            "document_number": "1023711432",
            "document_type": "CC",
            "names": "Lupita",
            "person_type": "natural",
            "surnames": "Pérez Gómez"
          },
          "kind": "co_person"
        }
      },
      "recipient_data": {
        "key_type": "alphanumeric",
        "key_value": "@MN1A2B3C4D5E",
        "payment_id": "CO.COM.CRB.TRXIDP1234567891234"
      },
      "transaction_data": {
        "end_to_end_id": "0198c2f3-9d4a-7b21-9e5f-3a8b2c4d6e7f"
      },
      "amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "calculated_fees": {
        "payin": {
          "amount": {
            "amount": 100000000,
            "currency": "COP"
          },
          "id": "fee_5tgliBmzjZ6mpQPRbQjfKj"
        },
        "payin_payer_spread": {
          "amount": {
            "amount": 100000000,
            "currency": "COP"
          },
          "id": "fee_5tgliBmzjZ6mpQPRbQjfKj"
        },
        "payin_subaccount_spread": {
          "amount": {
            "amount": 100000000,
            "currency": "COP"
          },
          "id": "fee_5tgliBmzjZ6mpQPRbQjfKj"
        }
      },
      "funding_account_id": "facc_5tgliBmzjZ6mpQPRbQjfKj",
      "funding_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "funds_delivery_method": "co_breb",
      "funds_delivery_mode": "automatic",
      "funds_delivery_status": "completed",
      "funds_destination": "funding_account",
      "id": "cpin_5tgliBmzjZ6mpQPRbQjfKj",
      "inserted_at": "2022-01-01T01:00:00Z",
      "intent_id": "cpint_5tgliBmzjZ6mpQPRbQjfKj",
      "merchant_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "metadata": {
        "id": 3,
        "reference": 123
      },
      "method": "co_breb",
      "redirect_url": "https://merchant.example.com/checkout/return",
      "settlement_batch_id": "cpisb_5tgliBmzjZ6mpQPRbQjfKj",
      "state": "subaccount_credited",
      "state_reason": null,
      "subaccount_amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "subaccount_disbursement_trigger": "on_approval",
      "subaccount_id": "lacc_5tgliBmzjZ6mpQPRbQjfKj",
      "template_id": "cpitpl_5tgliBmzjZ6mpQPRbQjfKj",
      "updated_at": "2022-01-01T01:00:00Z"
    }
  ]
}
{
  "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"
}