🚧 This project is currently in active development. A sandbox environment will be made available soon for testing and exploration. Stay tuned!

Schedule Payout

Developing

PATCH

https://ws2-payments.datmanpay.comapi/v1/schedule-transfer/<mid>/<ST_id>

Update Scheduled Transfer API

Overview

This API allows you to update an existing custom transfer payout schedule for a specific merchant. It is useful when you want to modify the timing or frequency of payouts without resetting the entire schedule from scratch.

The update is done via a PATCH request and applies only if the merchant has already set up a custom schedule using the Schedule Transfer POST API.

If no custom schedule exists, you must first create one using the POST API before using this endpoint.

Key Points

Allows partial updates to an existing scheduled transfer configuration.

Works only if a custom schedule has already been set.

Ideal for modifying cron expressions, descriptions, or reference values.

Default daily payouts remain unaffected unless explicitly changed.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://ws2-payments.datmanpay.comapi/v1/schedule-transfer/<mid>/<ST_id>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "merchant_id": "63123",
  "currency": "EUR",
  "schedule": "30 17 * * MON", // cron expression
  "description": "",
  "refrence": ""
}'

Response Example

[
    {
        "id": "lEZ5rgQ2QLP1KD6XLcH7S",
        "currency": "AUD",
        "schedule": "MON * * *", // cron
        "status": "active"
    },
    {
        "id": "lEZ5rgQ2QLP1KD6cH7S",
        "currency": "AUD",
        "schedule": "MON * * *", // cron
        "status": "active"
    }
]

Request

Body Params application/json

merchant_id

string

required

currency

string

required

schedule

string

required

cron expression

description

string

required

refrence

string

required

Examples

Responses

🟢200Success

application/json

Body

array of:

string

required

currency

string

required

schedule

string

required

cron

status

string

required

Schedule Payout

Account status

Schedule Payout

Update Scheduled Transfer API#

Overview#

Key Points#

Request

Responses

Update Scheduled Transfer API

Overview

Key Points