Skip to content

Currency converter

The Currency converter lets the merchant calculate the transaction amount equivalent in the required currency based on the currency exchange rate provided by the exchange rate source available in the converter settings.

The currency being converted is called base currency and the currency into which the amount is converted is called quote currency within the applied exchange rate.

The converter lets the merchant set a price in a currency that is different from the ones supported by their acquirer. Also, the converter lets the merchant calculate the transaction amount into another currency supported by the gateway but not use it in the transaction request to the acquirer.

The converted amount will be available to the customer in the webhook notification, in the response to the transaction, in the report and on the Transaction details page.

The converter can be used for the transactions of payment, authorization, payout, refund, capture and void types.

The conversion rate of refund transaction will equal the conversion rate of the corresponding payment transaction. The conversion rate for capture/void will equal the conversion rate for the corresponding authorization transaction.

Please contact your manager or the Tech Support Team to set up the converter.

conversion object

conversion object will be sent in the synchronous response to the transaction, in the response to the transaction status query and in the webhook notification if the currency converter is set up for the gateway used for the transaction processing.

object
object
Object with conversion information.
converted_amount
bigInteger
Transaction amount in the quote currency in minimal currency units.
converted_currency
string
Quote currency in ISO-4217 alpha-3 code format.
object
:{base currency}_TO_{quote-currency}
float
Exchange rate used for the calculation (1 unit of base currency in quote currency), base currency unit ÷ quote currency unit.
exchange_rate_ids
array
Array of the identifiers of the applied exchange rates.
exchange_rate_date
string
The date and time when the exchange rate was imported from the exchange rate source in the following format: YYYY-MM-DDThh:mm:ss[.SSSSSS]Z.
Example of the response to the payment request with the conversion object
{
    "transaction": {
        "uid": "d6f8180e-559b-4662-8509-a60083326e4f",
        "status": "successful",
        "amount": 70,
        "currency": "EUR",
        "description": "Test transaction",
        "type": "payment",
        "payment_method_type": "credit_card",
        "tracking_id": "tracking_id_000",
        "message": "Transaction is successful.",
        "test": true,
        "created_at": "2026-01-11T20:50:33.326Z",
        "updated_at": "2026-01-11T20:50:40.075Z",
        "paid_at": "2026-01-11T20:50:40.008Z",
        "expired_at": null,
        "recurring_type": null,
        "closed_at": null,
        "settled_at": null,
        "manually_corrected_at": null,
        "language": "en",
        "credit_card": {
            "holder": "John Doe",
            "stamp": "d1c853d9d6623ad497d6df0f90b92d19ae8393913b17198ac6006bdc2700485a",
            "brand": "visa",
            "last_4": "0000",
            "first_1": "4",
            "bin": "420000",
            "bin_8": "42000000",
            "issuer_country": "US",
            "issuer_name": "VISA Demo Bank",
            "product": "F",
            "exp_month": 10,
            "exp_year": 2028,
            "token_provider": null,
            "token": null
        },
        "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/d6f8180e-559b-4662-8509-a60083326e4f/db5bb9124efe90cb506d87e49e4781df566e6d7f6603c6f7e0f70d162db064dd?language=en",
        "status_code": null,
        "gateway": {
            "iframe": true
        },
        "mute_notifications": null,
        "version": 3,
        "psp_settled_at": null,
        "registry_id": null,
        "three_ds_expired_at": null,
        "id": "d6f8180e-559b-4662-8509-a60083326e4f",
        "redirect_url": "https://demo-gateway.begateway.com/process/d6f8180e-559b-4662-8509-a60083326e4f",
        "code": "S.0000",
        "friendly_message": "The transaction is successfully processed.",        
        "conversion": {
            "converted_amount": 81,
            "converted_currency": "USD",
            "exchange_rate": {
                "EUR_TO_USD": 1.1641075001251164
            },
            "exchange_rate_ids": [
                1985952
            ],
            "exchange_rate_date": "2026-01-11T20:03:02.932966Z"
        },
        "payment": {
            "auth_code": "654321",
            "bank_code": "05",
            "rrn": "999",
            "ref_id": "777888",
            "message": "Payment was approved",
            "amount": 70,
            "currency": "EUR",
            "billing_descriptor": "TEST GATEWAY BILLING DESCRIPTOR",
            "gateway_id": 3549,
            "status": "successful"
        },
        "avs_cvc_verification": {
            "avs_verification": {
                "result_code": "1"
            },
            "cvc_verification": {
                "result_code": "1"
            }
        },
        "customer": {
            "ip": null,
            "email": null,
            "device_id": null,
            "birth_date": null,
            "external_id": null
        },
        "billing_address": {
            "first_name": null,
            "last_name": null,
            "middle_name": null,
            "address": null,
            "country": null,
            "city": null,
            "zip": null,
            "state": null,
            "phone": null
        }
    }
}