---
title: "Get fiat top-up instructions"
method: GET
path: "/v3/topups/fiat/instructions"
tags: ["Fiat top-up"]
---

# Get fiat top-up instructions

`GET /v3/topups/fiat/instructions`

## Request

- Base URL: `https://confirmo.net/api`
- URL: `https://confirmo.net/api/v3/topups/fiat/instructions`
- Auth: HTTP bearer

Returns fiat top-up instructions for every currency the authenticated merchant has set up.

**Prerequisites:** For webhook notifications to be delivered for a fiat top-up, the merchant must first configure the `notifyUrl` via the Merchant Settings page in the GUI. If no `notifyUrl` is configured, top-up instructions are still returned but no webhook will be sent.

**Webhook:** Confirmo sends one webhook per top-up status:
- `DONE`: the top-up is credited to the merchant balance
- `NOT_WHITELISTED`: the top-up is held and not credited, its sender is not on the whitelist

`amount` is the amount received. `fee` is the Confirmo top-up fee deducted from `amount`, in `currency`. Zero when no fee applies, always set once the status is `DONE`, null while the top-up is held. The merchant balance grows by `amount` minus `fee`.

## Response `200`

Top-up instructions returned successfully.

- FiatTopUpInstructionsResponse
  - `instructions` union[]: Fiat top-up instructions across every currency the merchant has set up.
    - union
      - IbanTopUpInstructionTo: Top-up instructions for accounts identified by IBAN.
        - `type` string, required
        - `beneficiaryName` string: Name to quote as the beneficiary (account holder) on the transfer: the name registered for the receiving account with the banking provider. Depending on the provider this is the institution holding the account rather than your own company name. Omitted when the provider supplies none.
        - `bic` string: BIC of the top-up account.
        - `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 top-up account.
        - `iban` string: IBAN of the top-up account.
        - `notifyUrl` string, url: Notify URL as supplied in Merchant Settings.
        - `paymentSchemes` string[]: Payment schemes accepted for this account.
      - WireTopUpInstructionTo: Top-up instructions for wire deposits.
        - `type` string, required
        - `accountNumber` string: Account number to wire funds to.
        - `beneficiaryAddress` WireMailingAddressTo: Postal address for a wire deposit.
          - `address1` string
          - `address2` string
          - `city` string
          - `country` string
          - `province` string
          - `zipCode` string
        - `beneficiaryName` string: Name to quote as the beneficiary (account holder) on the transfer: the name registered for the receiving account with the banking provider. Depending on the provider this is the institution holding the account rather than your own company name. Omitted when the provider supplies none.
        - `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 top-up account.
        - `intermediaryRoutingDetails` WireRoutingDetailsTo: Bank routing details for a wire deposit.
          - `bankAddress` WireMailingAddressTo: Postal address for a wire deposit.
            - `address1` string
            - `address2` string
            - `city` string
            - `country` string
            - `province` string
            - `zipCode` string
          - `bankName` string
          - `routingNumber` string
          - `routingNumberType` string: Routing scheme.
        - `memoId` string: Memo to quote on the wire transfer so the deposit is attributed correctly.
        - `notifyUrl` string, url: Notify URL as supplied in Merchant Settings.
        - `routingDetails` WireRoutingDetailsTo: Bank routing details for a wire deposit.
          - `bankAddress` WireMailingAddressTo: Postal address for a wire deposit.
            - `address1` string
            - `address2` string
            - `city` string
            - `country` string
            - `province` string
            - `zipCode` string
          - `bankName` string
          - `routingNumber` string
          - `routingNumberType` string: Routing scheme.

## Other responses

- `400`: Top-up instructions unavailable (feature disabled, unsupported workflow, no active accounts, or the merchant status does not allow top-ups).
- `403`: Forbidden
- `409`: Conflict

---

[API](https://skmtc.dev/confirmo/apis/confirmo-api.md) - [All operations](https://skmtc.dev/confirmo/apis/confirmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/confirmo/apis/confirmo-api/revisions/09bef7db3dd1?raw)