Skip to main content

VOLT

This page provides an overview of the payments methods provided by the VOLT adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating VOLT within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

Payment Methods

Payment MethodTransaction FlowsTransaction Types
BankTransferHosted Payment Page, Embedded checkoutDebit, Refund, Partial refund
PixRedirectDebit, Refund

Additional Parameters

ParameterAllowed valuesDescription
extraData.languagebg, ce, de, en, es, fr, hr, it, lt, lv, nl, pl, pt, ro, sl, skDefines the language of the Volt Payment Page. Default is en
customer.billingCountryAT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HR, HU, IE, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SE, SI, SKIf provided with one of the following parameter the bank country will be preselect. If its not one of the predefined the customer will just have to select the bank themself
extraData.bank_idID received from option call*Redirects to the customer directly to his bank information without the need to select a bank on VOLT side
extraData.typeBILL, GOODS, PERSON_TO_PERSON, OTHER, SERVICESTransaction Type, default is OTHER
extraData.validity_periodSetting a custom expiration time for your Pay By Link is mandatory. Enter the desired validity in minutes. For instance, to make the link valid for 1 day, set it to 1440 (24 hours * 60 minutes)
extraData.beneficiary_nameEUR and GBP! Available if dynamic beneficiary is activated in the connector settings
extraData.beneficiary_ibanEUR only! Available if dynamic beneficiary is activated in the connector settings
extraData.beneficiary_swiftEUR only! Available if dynamic beneficiary is activated in the connector settings
extraData.beneficiary_account_numberGBP only! Available if dynamic beneficiary is activated in the connector settings
extraData.beneficiary_sort_codeGBP only! Available if dynamic beneficiary is activated in the connector settings
customer.extraData.documentIdCan be 11 or 14 digits long and the type has to be String.Available if sendPayerData is activated in the connector settings.
customer.referenceAvailable if sendPayerData is activated in the connector settings. Is mandatory if customer.email or customer.name or customer.ip is set.
customer.emailAvailable if sendPayerData is activated in the connector settings. If set the customer.reference will be mandatory.
customer.nameAvailable if sendPayerData is activated in the connector settings. If set the customer.reference will be mandatory.
customer.ipAvailable if sendPayerData is activated in the connector settings. If set the customer.reference will be mandatory.

Pix

Transaction fieldsRequiredDescription
customer.identificationtruefor debit transactions
customer.firstNametruefor debit transactions
customer.lastNametruefor debit transactions
customer.extraData.documentIdtruefor debit transactions

BankTransfer

Transaction fieldsRequiredDescription
customer.identificationtruefor debit transactions

Options Request

You can find more information about the options request here: Options Request

Retrieving a list of available banks

Returns a list of available banks with there id that can be used for the bank_id

Please use bank-list as an option name e.g. POST /options/{apiKey}/bank-list.

BankList Parameters

NameTypeRequiredDescription
parameters.pageintfalseGet the page with up to 100 entries