Fiat withdrawal

Pause a scheduled fiat withdrawal

Moves an ACTIVE schedule to PAUSED and cancels its next scheduled run. Calling pause on a schedule that is already PAUSED returns the current state without further effect. Rejected with 400 from CANCELLED. Returns 404 for deleted or missing schedules.

post/v3/withdrawals/fiat/schedules/{scheduleId}/pause

Request

Base URL
https://confirmo.net/api
URL
https://confirmo.net/api/v3/withdrawals/fiat/schedules/{scheduleId}/pause
Auth
HTTP bearer

Path parameters

scheduleIdstring required

Schedule ID

Response

Schedule paused successfully (or already PAUSED).

accountIdstring

ID of the fiat withdrawal account being swept.

createdAtinteger

When the schedule was created.

currency'AED' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BDT' | 'BGN' | 'BHD' | 'BND' | 'BOB' | 'BRL' | 'BYN' | 'CAD' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DKK' | 'DOP' | 'DZD' | 'EUR' | 'FKP' | 'GBP' | 'GEL' | 'GTQ' | 'HKD' | 'HRK' | 'HUF' | 'CHF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JPY' | 'KGS' | 'KHR' | 'KWD' | 'KZT' | 'LTL' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'PEN' | 'PHP' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UAH' | 'USD' | 'UYU' | 'VND' | 'XCD'

Currency being swept.

frequency'DAILY' | 'WEEKLY' | 'MONTHLY'

Sweep cadence.

frequencyDayinteger

Day selector. Null for DAILY; 1-7 (Monday=1) for WEEKLY; 1-31 for MONTHLY.

idstring

ID of the schedule.

minimumAmountnumber

Minimum the net swept amount must reach for a withdrawal to be created. Null when no minimum is enforced.

minimumBalancenumber

Balance floor — only the excess above this value is swept.

nextRunAtinteger

When the schedule will next be processed by the sweep job.

status'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'DELETED'

Current status of the schedule.

Example response

{
  "accountId": "fwaAbCdEf123456",
  "currency": "EUR",
  "frequency": "WEEKLY",
  "frequencyDay": 1,
  "id": "fwsAbCdEf123456",
  "status": "ACTIVE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.