Fiat top-up

Get fiat top-up instructions

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.

get/v3/topups/fiat/instructions

Request

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

Response

Top-up instructions returned successfully.

Example response

{
  "instructions": [
    {
      "beneficiaryName": "Example Merchant Ltd",
      "bic": "BFRILI22",
      "currency": "EUR",
      "iban": "LI6308800987654321001",
      "notifyUrl": "https://example.com/webhook",
      "paymentSchemes": [
        "SEPA",
        "SWIFT"
      ]
    }
  ]
}

Changes

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