Money Movement Scheduler

The Scheduler Money Movements API allows you to schedule recurrent Money Movements from one or multiple source accounts to a single destination.

This solution is commonly used to:

Run recurring payouts (e.g., periodic vendor disbursements).

Centralize balances by sweeping multiple accounts into one destination account.

Automate operations without manual initiation on each cycle.

Supported modes

It supports two scheduling modes: Static Amount Scheduling and Account Sweeping Scheduling.

Static Amount Scheduling

Enables the configuration of scheduled money movements for a specific, predefined amount. The system will include logic to transfer the specified amount on a recurring basis, according to the configured schedule. Users can configure multiple accounts simultaneously, transferring funds from several accounts to a designated account.

Account Sweeping Scheduling

Enables the configuration of scheduled money movements to automatically sweep accounts, effectively 'emptying' them at specified, recurring times. It allows for the simultaneous sweeping of multiple accounts, transferring funds from multiple accounts to a designated account. To activate this option, simply enter a zero in the amount field.

Allowed Money Movement combinations

The following combinations are available within the money movement scheduler:

Colombia combinations

Mexico combinations

Flow	Sources	Allowed source type	Destinations	Allowed destination type
Push	`account_id` (One or many)	Checking (`cc`), Saving (`ch`), `cobre_balance`	`counterparty_id`	Checking (`cc`), Saving `(`ch), `cobre_balance`, Electronic Deposit (`dp`)

Cron configuration

The cron expression syntax will have the Amazon CloudWatch specifics:

cron(Minutes Hours Day-of-Month Month Day-of-Week Year)

Specifics

Minutes (0-59): The minute when the task should start.

Hours (0-23): The hour (in 24-hour format) when the task should start.

Day-of-Month (1-31): The specific day of the month.

Month (1-12 or JAN-DEC): The month the task should run.

Day-of-Week (1-7 or SUN-SAT): The day of the week the task should run.

Year (optional): The year when the task should run.

Cron Examples

(0 0 * * ? *): This will run every day at 00:00 UTC (Midnight).

(0/5 * * * ? *): This will run every 5 minutes, starting at the top of the hour.

(0 9 1 * ? *): This will run the first day of every month at 9 AM

Money movements generated

Once the scheduled time is reached, the scheduler will initiate an execution that creates Money Movements for each account listed in the account_source_ids. For every execution, a unique ID will be generated for the scheduling and added to the batch_id field, and the scheduler_id will be mapped to the Money Movement's external_id.

The Money Movement request body will align with the one defined in the Money Movement scheduler object as follows:

{
    "id": "mm_3Lyw3BQmRvHfZB",
    "batch_id": "mmse_Vh88EH2aFa",          // Batch id of the money movement scheduler
    "external_id": "mms_Lwjdfa2L7CJEZ3",    // Will be the same as the money movement scheduler id.
    "type": "spei",
    "geo": "mex",
    "status":
    {
        "state": "completed",
        "code": "",
        "description": ""
    },
    "source_id": "acc_lg61ErGNyK",             // Will show the source_id from array of strings of account sweeper
    "source": null,
    "destination_id": "cp_fXSpJtAA60",
    "destination": null,
    "currency": "mxn",
    "amount": 1,                               // Will show either the fixed amount or the account balance amount. (depending on the scheduler configuration)
    "metadata":
    {
        "description": "Daily Scheduled payment at 18:00 pm!",    // Will be the same as the description from the money movement scheduler
        "reference": "20240918",                                  // Will generate the date of the payment: Format YYYYMMDD (onbly for spei payments)
        "tracking_key": "202409189071045080000524478820",
        "cep_url": "https://www.banxico****"
    },
    "created_at": "2024-09-18T18:00:00.12Z",
    "updated_at": "2024-09-18T18:01:03.76Z"
}

If a functional error occurs, the Money Movement object will still be created, and the error (from the errors list) will be included in the description of the money movement.

Bulk lifecycle

A Payout through Scheduler Money Movement follows a simple lifecycle:

Create the scheduler
Define account_source_ids, destination_id, the schedule_pattern, and either a fixed amount or amount = 0 for sweeping.

Scheduler triggers executions automatically
At each scheduled run, Cobre generates the corresponding Money Movement(s).

Track outcomes via Money Movements and Webhooks
Each generated Money Movement follows the standard lifecycle and can be tracked with retrieval endpoints and webhooks.

Actions performed on Scheduler Money Movements

🔑 Create

🔍 Retrieval

❌ Delete

Description: Scheduler Money Movement Creation.
What to expect after the action: Scheduler Money Movement is created in Cobre.
📘 Learn more:

🔗 Create a Scheduler Money Movement

How to Get Started

Before you begin, we recommend reviewing the following considerations.

Before using this API

Choose your scheduler type

Use a fixed amount for Static Amount Scheduling, or set amount = 0 to enable Account Sweeping Scheduling.

Validate allowed combinations

Ensure the source account types and destination counterparty type match the supported combinations for the selected country.

Define your schedule pattern

Configure schedule_pattern using Amazon CloudWatch cron syntax to control when the scheduler runs.

Implement Webhooks to track payment status

To stay informed about the status of Payout transactions, we strongly recommend implementing Webhooks. Webhooks notify your system when a payment is initiated, processed, completed, or failed. Also subscribe to the required events to receive notifications about transaction debits and credits.

See Notifications for more details.

What to expect after using this API

Recurring Money Movements are generated

The scheduler automatically triggers Money Movements according to your configured schedule.

Reconcile results using Money Movement data

Use Money Movement retrieval endpoints and your external_id/metadata strategy to reconcile scheduled executions.

Cancel schedulers when no longer needed

If the automation is no longer required, cancel the scheduler to prevent future executions.

Money Movement Scheduler

Supported modes#

Static Amount Scheduling#

Account Sweeping Scheduling#

Allowed Money Movement combinations#

Cron configuration#

Money movements generated#

Bulk lifecycle#

Actions performed on Scheduler Money Movements#

How to Get Started#

Before using this API#

What to expect after using this API#

Supported modes

Static Amount Scheduling

Account Sweeping Scheduling

Allowed Money Movement combinations

Cron configuration

Money movements generated

Bulk lifecycle

Actions performed on Scheduler Money Movements

How to Get Started

Before using this API

What to expect after using this API