Skip to main content

Documentation

Core Parameters

Parameter name	Type	Description
printReceipt	Boolean	True if receipts should be printed by default
refund	Boolean	True if refund is enabled for device
refundSecure	Boolean	True if refund should require merchant password
paymentSwitch_ip_host	String	The primary connection host to send transactions.
paymentSwitch_ip_host2nd	String	The secondary connection host to send transactions when primary is not available. This parameter is hidden.
audioSetting	String	The audio settings for the device, possible values: MUTE, AUDIO, SILENT_KEYBOARD
useOnScreenSignature	Boolean	Boolean value indicating whether the signature should be written on screen or on paper.
disableSignatureCheck	Boolean	True means the signature check is disabled.
additionalZeros	Boolean	Set to true when 00 and 000 should be shown on the amount keyboard
pinBypass	Boolean	Set to true when pin bypass should be allowed. This parameter is hidden.
mailHost	String	The mail host used for sending mail from device.
mailPort	String	The mail port.
mailUser	String	The mail user used for outgoing mails.
mailPassword	String	The mail password used for outgoing mails.
mailSender	String	The mail sender address used for outgoing mails.
currentTheme	String	Sets the default theme for the core, possible values are: DARK, LIGHT
debitCardsAccepted	Boolean	Boolean indicating whether debit cards will be accepted
creditCardsAccepted	Boolean	Boolean indicating whether credit cards will be accepted
commercialCardsAccepted	Boolean	Boolean indicating whether commercial cards will be accepted
autoEodEnabled	Boolean	Boolean indicating whether auto end of day is sent. If true requires the autoEodTime to be set.
autoEodTime	String	The time to perform the automatic end of day, required if autoEodEnabled is true. Format: HHmm. 24h format.
addressVerification	Boolean	Set to true when address verification should be used. This is default “true” and this parameter is hidden.
language	String	The language of the core, format should be is_IS
customCardSupported	Boolean	Boolean indicating if reading of custom cards should be supported.
fixedAmount	String	The fixed amount that should be displayed. Null, removes the button, NaN adds a button for manual input (Only one custom)
fixedAmount2	String	The second fixed amount that should be displayed. Null, removes the button, NaN adds a button for manual input (Only one custom)
fixedAmount3	String	The third fixed amount that should be displayed. Null, removes the button, NaN adds a button for manual input (Only one custom)
fixedAmount4	String	The fourth fixed amount that should be displayed. Null, removes the button, NaN adds a button for manual input (Only one custom)
cashbackEnabled	Boolean	Boolean indicating whether cashback functionality is enabled.
maxSaleTransactionAmount	String	Numerical value, the maximum sale value, sales over this value will not be allowed.
maxSaleAmountDaily	String	Numerical value, maximum total sale amount during a day.
maxRefundTransactionAmount	String	Numerical value, the maximum refund value, refunds over this value will not be allowed.
maxRefundAmountDaily	String	Numerical value, maximum total refund amount during a day.
terminalLock	Boolean	Boolean indicating whether the terminal will require the user to input a password at restart of app.
displayTutorial	Boolean	Boolean indicating whether a tutorial should be displayed at initial startup of app.
loggingEnabled	Boolean	Boolean indicating whether logs should be sent to Datadog for terminal.
whiteLabel	Boolean	Boolean indicates whether Rapyd Logo and/or Powered by Rapyd is displayed.
cashAdvanceEnabled	Boolean	Boolean indicating whether this terminal has cash advanced enabled.
tipJar	Boolean	Boolean indicating whether tip jar functionality is enabled, in tip jar mode it is only possible to perform fixed amount transactions and the settings screen is disabled.
printMerchantReceiptFirst	Boolean	Boolean indicating if merchant receipt should be printed first.
printOnlyMerchantSignatureReceipt	Boolean	Boolean indicating if only merchant signature receipt should be printed.
printCardholderReceipt	Boolean	Boolean indicating if cardholder receipt should be printed.
displayReceiptTimer	String	The time that the on screen receipt will be displayed.
serviceCharge	String	The tip service charge fee, percentage fee. Valid values are between 0-100 with two decimal precision.
adminFee	String	Tip admin fee, admin fee value appended to all tip transactions.
orgId	String	The organization ID, required for Rapyd refunds.

Merchant parameters

For multi merchant _x is appended to the parameter name. Where x is between 2-10

Parameter name	Type	Description
stid	String	8 digit soft terminal id.
mid	String	15 digit merchant id.
moto	Boolean	True if MOTO is enabled for device
preauth	Boolean	True if preauth is enabled for device
amexSupportEnabled	Boolean	Boolean indicating whether the device should support AMEX cards
mccCode	String	Merchant MCC Code. 4 digits.
dccSupported	Boolean	Set to true when device should support DCC
receipt_merchant_line0	String	First merchant address line displayed on the receipt
receipt_merchant_line1	String	Second merchant address line displayed on the receipt
receipt_merchant_line2	String	Third merchant address line displayed on the receipt
receipt_merchant_line3	String	Fourth merchant line
receipt_merchant_line4	String	Fifth merchant line
receipt_merchant_line5	String	Sixth merchant line
receipt_merchant_line6	String	Seventh merchant line
currencyCode	String	The ISO 4217 alpha code. Dropdown list
countryNum	String	The numeric country code. 3 digits.
language	String	The language of the core, format should be is_IS
merchant_password	String	4 digit string with the merchant pin required for void and refunds
mailMerchant	Boolean	Boolean indicating whether merchant receipts should be mailed.
mailMerchantAddress	String	Mail address that mail receipts should be sent to.
printMerchantReceipt	Boolean	Boolean indicating whether merchant receipt should be printed.
tipEnabled	Boolean	Boolean indicating whether tip is enabled.
tipPrompted	Boolean	Boolean indicating whether tip is shown when doing transactions, can be toggled in terminal settings.
tipPercentage1	String	The first tip percentage, defaults to 10 if not set
tipPercentage2	String	The second tip percentage, defaults to 15 if not set
tipPercentage3	String	The second tip percentage, defaults to 20 if not set
sponsoredMerchantId	String	Partner sponsored merchant id. 8 digits.
dbaName	String	Partner dba name
dbaCity	String	Partner dba city
walletId	String	Merchant walletId

Partner UI parameters

Parameter name	Type	Description
Custom Theme File	File	Custom theme file modifying the color scheme, file needs to be named customColors.xml
Custom font File	File	Custom font file, need to be a TTF font file.
Custom loading animation	File	Custom loading animation, the animation that is shown when waiting on a transaction request. File needs to be a Lottie json file named loading.json
Custom approved animation	File	Custom approved animation, the animation that is shown when a transaction has been approved. File needs to be a Lottie json file named approved.json
Custom declined animation	File	Custom decline animation, the animation that is shown when a transaction has been declined. File needs to be a Lottie json file named declined.json
Custom read card animation	File	Custom read card animation, the animation is shown when the cardholder is prompted for a card. File needs to be a Lottie json file named read_card.json
Custom approved success animation	File	Custom approved success animation, overlay animation that can be used to overlay any effects on the transaction approved screen. Needs to have a transparent background. File needs to be a Lottie json file named approved_success.json
Screen logo	File	Logo file that is shown on the receipt screen. Should be an image file, preferably a PNG or JPEG. File needs to be named screenlogo
Alternative Screen Logo	File	Logo file that is shown on the receipt screen. Should be an image file, preferably a PNG or JPEG. File needs to be named alternativescreenlogo. Has to also have screen logo. Will be shown in Dark theme and Screen Logo will be shown in Light theme. Does not work with Custom Colors
Receipt logo	File	Logo file that is shown on the printed receipt. Should be an image file, preferably a PNG or JPEG. File needs to be named receiptlogo
Custom UI	File	ZIP file containing the custom lottie animation files and custom sound files: loading.json - The loading animation in lottie json format. approved.json - The approved animation in lottie json format. declined.json - The declined animation in lottie json format. read_card.json - The read card animation in lottie json format. approved_success.json - The approved success animation in lottie json format. approvedSound.mp3 - The approved sound effect in mp3 format. failSound.mp3 - The declined sound effect in mp3 format.

Custom card bins

Custom file specifying the supported custom card bins, e.g. bins for which we should forward the PAN data.

Parameter name: cardBins
Parameter type: file
Required file name: cardBins.json

Example JSON file:

cardBins.json

{ 
    "customBins": [
        {
            "name": "Bonus",
            "binRange": "93523058"
        },
        {
            "name": "Hagkaup",
            "binRange": "93523058"
        }
    ],
    "discountBins": [
        {
            "name": "Orkan",
            "binRange": "93526020"
        }
    ]
}

In this section: