COconfirmo
Fiat withdrawal

Initiate fiat withdrawal

Initiates a fiat withdrawal from the merchant's balance to a registered bank account. Accepts API keys only.

Supports the optional Idempotency-Key header so a retry won't perform the operation twice - a fresh UUID per request is recommended. See <a href="#idempotent-requests">Idempotent requests</a> for more information.

post/v3/withdrawals/fiat

Request

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

Request body

accountIdstring required

ID of the fiat withdrawal account to withdraw to.

amountnumber required

Withdrawal amount.

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

Fiat currency code.

purposeOfPaymentstring

Optional purpose of payment.

referencestring

Optional payment reference. It reaches the beneficiary's bank statement as written, so it may hold only letters, digits, spaces and / ? : ( ) . , ' + -. No diacritics, and no non-breaking spaces of the kind text pasted from a document carries.

Example request

{
  "accountId": "fwaAbCdEf123456",
  "currency": "EUR",
  "purposeOfPayment": "Service payment",
  "reference": "Invoice 1234"
}

Response

Withdrawal initiated successfully.

amountnumber

Requested withdrawal amount.

createdAtinteger

Timestamp of creation.

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 of the withdrawal.

feeAmountnumber

Applied fee amount.

idstring

Withdrawal ID.

referencestring

Optional payment reference.

status'CREATED' | 'SENDING' | 'TRANSACTION_CREATED' | 'TRANSACTION_CREATE_FAILED' | 'TRANSACTION_SIGNED' | 'TRANSACTION_SIGN_FAILED' | 'COMPLETED' | 'TRANSACTION_EXTERNAL_PROCESSING_FAILED'

Withdrawal status.

statusChangedAtinteger

Timestamp of last status change.

type'ON_DEMAND' | 'SCHEDULED'

Initiation type — on-demand or scheduled.

Example response

{
  "currency": "EUR",
  "id": "fwiAbCdEf123456",
  "reference": "payment #1234",
  "status": "CREATED",
  "type": "ON_DEMAND"
}

Changes

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