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

Datman API's

Schedule Payout

Developing

GET

https://ws2-payments.datmanpay.com/api/v1/schedule-transfer/<mid>

Get Scheduled Transfer API

Overview

This API allows you to retrieve the custom transfer payout schedule configured for a specific merchant.

By default, when a merchant is onboarded, they are set up with a daily payout schedule. This GET API is only applicable if a custom schedule has been configured using the Schedule Transfer POST API.

If no custom schedule has been set, this API will not return any meaningful data.

Key Points

Use this API to check if a custom schedule is in place.

Works only if the schedule was explicitly set via the POST API.

Default setup is daily payouts for all merchants unless changed manually.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://ws2-payments.datmanpay.com/api/v1/schedule-transfer/<mid>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "request_id": "kshflshf",
  "data": [
    {
      "schedule_transfer_id": "ST123",
      "currency": "EUR",
      "schedule": "30 17 * * MON", // cron expression
      "description": "",
      "refrence": ""
    },
    {
      "schedule_transfer_id": "ST124",
      "currency": "EUR",
      "schedule": "30 17 * * MON", // cron expression
      "description": "",
      "refrence": ""
    }
  ]
}'

Response Example

[
  {
    "id": "lEZ5rgQ2QLP1KD6XLcH7S",
    "merchantAccount": "incididunt ea sint",
    "currency": "BYN",
    "schedule": "tempor velit minim",
    "status": "nulla magna aliquip culpa"
  },
  {
    "id": "YprgeSCiBiZOrl6r1Xn13",
    "merchantAccount": "pariatur deserunt aute id dolor",
    "currency": "STN",
    "schedule": "irure dolor Duis",
    "status": "consequat exercitation reprehenderit aliqua"
  },
  {
    "id": "A5Q6qHmF9jwTHmjA85Ah-",
    "merchantAccount": "fugiat id",
    "currency": "HKD",
    "schedule": "qui dolor",
    "status": "proident culpa tempor"
  }
]

Request

Body Params application/json

request_id

string

required

data

array [object {5}]

required

schedule_transfer_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

merchantAccount

string

required

currency

string

required

schedule

string

required

status

string

required

Schedule Payout

Schedule Payout

Get Scheduled Transfer API#

Overview#

Key Points#

Request

Responses

Get Scheduled Transfer API

Overview

Key Points