COconfirmo
Fiat withdrawal

Create a scheduled fiat withdrawal

Configures a recurring sweep of the merchant's fiat balance to a registered bank account. On success returns the newly created schedule in status ACTIVE. Accepts API keys only.

post/v3/withdrawals/fiat/schedules

Request

  • Base URL
    https://confirmo.net/api
  • URL
    https://confirmo.net/api/v3/withdrawals/fiat/schedules
  • Auth
    HTTP bearer

Request body

accountIdstring required

ID of the fiat withdrawal account to sweep.

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' required

Currency to sweep.

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

Sweep cadence.

frequencyDayinteger

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

minimumAmountnumber

Optional minimum the net swept amount must reach for a withdrawal to be created. When the sweep is below this value the run is skipped. Omit for no minimum.

minimumBalancenumber required

Balance floor in major units of the selected currency. Only the excess above this floor is swept.

Example request

{
  "accountId": "fwaAbCdEf123456",
  "currency": "EUR",
  "frequency": "WEEKLY",
  "frequencyDay": 1
}

Response

Schedule created successfully.

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.