The settings here permit for a wide variety of options, and you can customize your SMS messages, screen messages, and receipts in ways that display your place as a professional in the market.
Custom strings define your BATM’s personality.
Expand by clicking the “>” below.
"text" may be printed on tickets, used onscreen, or sent in SMS messages.
"bmp" may only be used on printed tickets.
"qr(variablename)" may be used to create a QR code from any variable (PRINTED ONLY) - e.g.
This is a wallet QR code: {qr(text.crypto.destination)}
<b> begin bold type
</b> end bold type
<i> begin italics
</i> end italics
<br/> break (creates a new line after this)
You may NOT use "<" or ">" characters in your text (except as shown above)
The "strings" are just plain text formatted with HTML fields and graphics.
Example: <b>This is bold text</b> and <i>this is italicized text.</i> will be displayed as: This is bold text and this is italicized text. |
Unsorted, this list is presented in the same order as seen on the CAS Terminal web page.
Scroll towards the top to expand a linked list in alphabetical order.
NOTE ABOUT CUSTOM STRINGS:
|
The phone number displayed on your BATM screen for support.
(Empty - no default set)
The time (in minutes) of the expected delay for identity registration. This is displayed on the BATM screen for your customer after they choose to register.
15 |
After these # minutes, the “sell success” screen on the BATM will return to the main/normal screen.
300 |
This is printed when a paper wallet is chosen.
<b>PAPER WALLET - {text.cryptoCurrency}</b><br/><br/><br/><b>Spend</b><br/>{text.cryptoCurrency} - private key - keep this QR code private!{bmp.privatekey}{text.privatekey}{bmp.logo}<b>Load</b><br/>{text.cryptoCurrency} - public key<br/>{text.address}{bmp.address}<br/> |
The paper BUY receipt contents are set here.
{bmp.logo}<b>BUY CRYPTO RECEIPT</b><br/><br/><b>TX ID:</b> {text.transaction.id}<br/><b>Time:</b> {text.time}<br/><b>Price:</b> {text.fiat.amount} {text.fiat.currency}<br/><b>Fixed Fee:</b> {text.fiat.fee.fixed} {text.fiat.currency}<br/><b>Crypto:</b> {text.crypto.amount} {text.crypto.currency}<br/><b>Rate:</b> 1 {text.crypto.currency} = {text.crypto.rate} {text.fiat.currency}<br/><b>Destination:</b> {text.crypto.destination}<br/><br/>Keep this receipt!<br/><br/><b>Operator:</b> Name, Address, Phone, etc<br/><br/> |
When a Lightning BUY is prepared, this ticket will be printed.
{bmp.logo}<b>BUY CRYPTO RECEIPT</b><br/><br/><b>TX ID:</b> {text.transaction.id}<br/><b>Time:</b> {text.time}<br/><b>Price:</b> {text.fiat.amount} {text.fiat.currency}<br/><b>Additional Fee:</b> {text.fiat.fee.fixed} {text.fiat.currency}<br/><b>Percentage Fee:</b> {text.fee.percentage}%<br/><b>Crypto:</b> {text.crypto.amount} {text.crypto.currency}<br/><b>Rate:</b> 1 {text.crypto.currency} = {text.crypto.rate} {text.fiat.currency}<br/><br/>{bmp.lnurl}<br/><br/>Use LNURL wallet to withdraw<br/><br/> |
This SMS message is sent to customers after a BUY when using the optional SMS delivery.
BUY CRYPTO RECEIPT TX ID: {text.transaction.id} Time: {text.time} Price: {text.fiat.amount} {text.fiat.currency} Fixed Fee: {text.fiat.fee.fixed} {text.fiat.currency} Crypto: {text.crypto.amount} {text.crypto.currency} Destination: {text.crypto.destination} |
This email message is sent to customers after a BUY when using the optional email delivery. Supports basic HTML tags.
{bmp.logo}<b>BUY CRYPTO RECEIPT</b><br/><br/><b>TX ID:</b> {text.transaction.id}<br/><b>Time:</b> {text.time}<br/><b>Price:</b> {text.fiat.amount} {text.fiat.currency}<br/><b>Fixed Fee:</b> {text.fiat.fee.fixed} {text.fiat.currency}<br/><b>Crypto:</b> {text.crypto.amount} {text.crypto.currency}<br/><b>Rate:</b> 1 {text.crypto.currency} = {text.crypto.rate} {text.fiat.currency}<br/><b>Destination:</b> {text.crypto.destination}<br/><br/><br/><b>Operator:</b> Name, Address, Phone, etc<br/><br/> |
This paper offer prints after a SELL is negotiated. It displays the QR code and crypto amount the customer is required to send to you to consummate your offer. The ticket is then scanned at the BATM for the customer to withdraw the agreed upon fiat.
{bmp.logo}<b>SELL CRYPTO RECEIPT AND REDEEM TICKET</b><br/><br/><b>TX ID:</b> {text.transaction.id}<br/><b>Time:</b> {text.time}<br/><b>Price:</b> {text.fiat.amount} {text.fiat.currency}<br/><b>Fixed Fee:</b> {text.fiat.fee.fixed} {text.fiat.currency}<br/><b>Crypto:</b> {text.crypto.amount} {text.crypto.currency}<br/><b>Rate:</b> 1 {text.crypto.currency} = {text.crypto.rate} {text.fiat.currency}<br/><b>Destination:</b> {text.crypto.destination}<br/><b>UUID:</b> {text.transaction.uuid}<br/><br/><b>Operator:</b> Name, Address, Phone, etc<br/><br/><b>How to proceed:</b><br/><b>1.Please send exactly </b> {text.crypto.amount} {text.crypto.currency} to <br/>{text.crypto.destination}<br/><b>before {text.transaction.expirationTimestamp}.</b>{bmp.paymentrequest}<br/><b>2.Wait a few minutes before your payment is confirmed.</b><br/><b>3.On machine choose REDEEM TICKET.</b><br/><b>4.Scan QR code on this ticket.</b><br/><br/><b>DON'T LOSE THIS REDEEM TICKET!!</b><br/><b>TICKET IS NEEDED FOR CASH WITHDRAWAL!!</b><br/>{bmp.logo}<br/> |
This SMS is sent after a SELL is negotiated. It contains the target wallet and crypto amount the customer is required to send to you to consummate your offer.
SELL CRYPTO RECEIPT AND REDEEM TICKET {text.transaction.id}. Please send {text.crypto.amount} {text.crypto.currency} to {text.crypto.destination} before {text.transaction.expirationTimestamp}. Wait until your payment is confirmed. On machine choose REDEEM TICKET. Scan the following QR code: https://coin.cz/qrcode.html?qrcodetext={text.paymentrequest} Price: {text.fiat.amount} {text.fiat.currency}, Fee: {text.fee.percentage}% + {text.fiat.fee.fixed} {text.fiat.currency}, Rate: 1 {text.crypto.currency} = {text.crypto.rate} {text.fiat.currency} |
An SMS message cannot contain an image, thus a QR code cannot be directly sent. The URL in this example embeds a QR image (via coin.cz) sendable by SMS.
A QR code is required for the customer to present at the BATM for the withdrawal.
This message is sent to a customer to permit a manually-created redemption (REDEEM) transaction. The message includes a REDEEM QR code.
{bmp.logo}<b>CASHBACK RECEIPT AND REDEEM TICKET</b><br/><br/><b>TX ID:</b> {text.transaction.id}<br/><b>Time:</b> {text.time}<br/><b>Amount:</b> {text.fiat.amount} {text.fiat.currency}<br/><br/>{qr(cashback)}<br/>How to proceed:<br/>1. Choose REDEEM TICKET on the ATM.<br/>2. Scan the QR code on this ticket.<br/><br/>DON'T LOSE THIS REDEEM TICKET!!<br/>TICKET IS NEEDED FOR CASH WITHDRAWAL!!<br/>{bmp.logo}<br/> |
This paper SELL receipt is printed by the BATM after the fiat has been withdrawn by the customer.
{bmp.logo}<b>CASH WITHDRAWAL RECEIPT</b><br/><br/><b>TX ID:</b> {text.transaction.id}<br/><b>Related TX:</b> {text.transaction.related.id}<br/><b>Time:</b> {text.time}<br/><b>Amount:</b> {text.fiat.amount} {text.fiat.currency}<br/><b>UUID:</b> {text.transaction.uuid}<br/><br/><b>Operator:</b> Name, Address, Phone, etc<br/><br/><br/>{bmp.logo}<br/> |
If a BUY transaction fails, the paper receipt contents are set here.
{bmp.logo}<b>BUY CRYPTO RECEIPT</b><br/><br/><b>TX ID:</b> {text.transaction.id}<br/><b>Time:</b> {text.time}<br/><b>Price:</b> {text.fiat.amount} {text.fiat.currency}<br/><b>Additional Fee:</b> {text.fiat.fee.fixed} {text.fiat.currency}<br/><b>Percentage Fee:</b> {text.fee.percentage}%<br/><b>Crypto:</b> {text.crypto.amount} {text.crypto.currency}<br/><b>Rate:</b> 1 {text.crypto.currency} = {text.crypto.rate} {text.fiat.currency}<br/><b>Destination:</b> {text.crypto.destination}<br/><br/>Keep this receipt!<br/><br/><b>Operator:</b> Name, Address, Phone, etc<br/><br/> |
Pre-transaction terms & conditions page shown at the BATM.
Supports basic HTML tags.
Creates a button on the BATM screen (when non-empty).
Add a "!" to the beginning of the string to force the customer to accept the terms & conditions prior to the transaction (“I AGREE” / ”CANCEL”).
Use !X! (e.g. !10!) - to wait X seconds before the Agree button is activated and can be clicked.
(Empty - no default set)
See these details: Scam Disclaimer
(Empty - no default set)
This SMS communicates that the SELL is ready for customer withdrawal.
Cash withdrawal {text.transaction.id} is ready. |
This SMS notifies your customer that the wrong amount has been submitted to the wallet specified in printer_sell_crypto_ticket_template.
Invalid payment {text.transaction.id} received. |
This SMS notifies your customer that your SELL offer has expired, and the payment was not received within the required time limit.
Sell offer {text.transaction.id} expired. Don't send the payment. |
This SMS notifies your customer that the coin satisfying the SELL terms has been seen on the network, and is waiting for the required confirmations (next: sell_withdrawal_ready).
Transaction {text.transaction.id} arriving, thank you. We will inform you when the cash withdrawal is ready. |
Replaces the default: "Welcome to Bitcoin ATM".
(Empty - no default set)
Replaces the default: "Buy Bitcoins" on the main screen
(Empty - no default set)
Replaces the default: "BUY BITCOINS!" on the screensaver
(Empty - no default set)
Used ONLY under direction of development / support. See chart (below).
(Empty - no default set)
Separate multiple fields using a space (" ").
The chart is at the bottom of this article.
These further instructions are displayed on the BATM screen to a customer in the event a BUY transaction fails (e.g. "Please call xxx-yyy-zzzz").
(Empty - no default set)
This additional notification is displayed on the BATM screen to a customer in the event a BUY transaction succeeds (e.g. "Please wait up to 3 hours for the coin to arrive.").
(Empty - no default set)
These further instructions are displayed on the BATM screen to a customer in the event a SELL transaction fails (e.g. "Please call xxx-yyy-zzzz").
(Empty - no message set)
If the BUY transaction is listed on a blacklist (OFAC, internal, etc), the message set here will be shown to the customer.
(Empty - no message set)
If the BUY transaction is scored (by a scoring service) as “high risk”, the message set here will be shown to the customer. See: https://generalbytes.atlassian.net/l/cp/bUgXUUs6
(Empty - no message set)
Replaces the default “Withdrawal is not possible. Not enough cash in the machine.” message.
(Empty - no message set)
These further instructions are displayed on the BATM screen to a customer in the event a REDEEM transaction fails (e.g. "Please call xxx-yyy-zzzz").
(Empty - no message set)
The message text when delivering one time SMS passwords to customers.
(Empty - no default set)
The OTP field is represented within the text by: {text.otp}
Example: Here is your GB OT passcode: {text.otp}
The BUY LIMIT title used during the chooseLimitScreen BUY flow.
(Empty - no default set)
The BUY LIMIT description used during the chooseLimitScreen BUY flow.
(Empty - no default set)
The BUY LIMIT fixed fee description used during the chooseLimitScreen BUY flow.
(Empty - no default set)
The SELL LIMIT title shown during the chooseLimitScreen SELL flow.
(Empty - no default set)
A SELL LIMIT subheading (e.g. “choose X”) shown during the chooseLimitScreen SELL flow.
(Empty - no override set)
The SELL LIMIT description shown during the chooseLimitScreen SELL flow.
(Empty - no default set)
Displays a custom Anonymous tier message on the BUY Choose Limit Screen button.
(Empty - no default set)
Displays a custom Not Registered tier message on the BUY Choose Limit Screen button.
(Empty - no default set)
Displays a custom Registered tier message on the BUY Choose Limit Screen button.
(Empty - no default set)
Displays a custom Anonymous tier message on the SELL Choose Limit Screen button.
(Empty - no default set)
Displays a custom Not Registered tier message on the SELL Choose Limit Screen button.
(Empty - no default set)
Displays a custom Registered tier message on the SELL Choose Limit Screen button.
(Empty - no default set)
Displayed to customers that are rejected due to PEP restrictions.
Please contact our support team {support_phone}. |
Displayed when new registrations are not being accepted, or are being pre-processed by third-parties (and registration is no longer performed at the BATM).
We are sorry, to register please visit (not set). |
Displays a custom title for the “Are you registered?” screen.
(Empty - no default set)
This SMS message will be sent to the Identity because their ID document expired.
We are sorry, you were unregistered due to the expiration of your ID document. |
This may be customized to comply with jurisdictional requirements.
(Empty - no default set)
Enables a custom cash collection ticket, as mandated by certain armored car (and other cash pickup) services. This is a subtitle (only).
(Empty - no default set)
Shown to the customer after successfully uploading the required registration documents.
(Empty - no default set)
This window (when displayed) shows after the QR has been presented by an UNREGISTERED or REGISTERED during a transaction. An “opt-in” is required for marketing in various regions.
(Empty - no default set)
For this message to be displayed:
this custom string must contain text,
the customer’s Identity must have a cellphone number,
the customer must not have previously opted-in to the marketing agreement.
Customize the title to the marketing opt-in agreement described above.
MARKETING AGREEMENT |
This additional message is displayed on-screen after the AML-triggered Registration Submitted screen.
Registration information was submitted successfully.<br/>We will inform you on {text.contact.info} when your account is activated. |
Displayed on screen after the “Cash Limit Screen” (if set).
Permitted variables: {text.fee.fixed}, {text.rate}, {text.rate.raw}
Add a "!" to the beginning of the string to force the customer to accept the disclosure prior to the transaction (“I AGREE” / ”CANCEL”).
Use !X! (e.g. !10!) - to wait X seconds before the Agree button is activated and can be clicked.
(Empty - no default set)
The {link} field is set in your Organization settings. Used with Onfido/Veriff.
Please use following link to verify your identity. {link} |
Used with Onfido/Veriff.
Verification was successful. You should be registered shortly. |
Used with Onfido/Veriff.
Congratulations, your registration was successful. |
Used with Onfido/Veriff.
Something went wrong and we have to verify you manually, sorry. It can take some time. |
Used with Onfido/Veriff.
Verification was unsuccessful. Please try again. |
The following custom messages may instead be presented to your customer onscreen when they exceed their respective limits.
(Empty - no default set for any of these messages)
exceeded_cash_limit_per_transaction
exceeded_cash_limit_per_hour
exceeded_cash_limit_per_day
exceeded_cash_limit_per_week
exceeded_cash_limit_per_month
exceeded_cash_limit_per_3_months
exceeded_cash_limit_per_12_months
exceeded_cash_limit_per_calendar_year_quarter
exceeded_cash_limit_per_calendar_year
exceeded_cash_limit_per_day_and_crypto_address
exceeded_total_cash_limit_per_crypto_address
exceeded_total_cash_limit_per_identity
exceeded_total_terminal_cash_limit_for_buy
exceeded_total_terminal_cash_limit_for_sell
An additional screen presented to the customer revealing any regionally required privacy policy declaration.
(Empty - no default set)
If wallet ownership verification is enabled in your AML/KYC settings, this text is shown on the button when the customer has chosen “no” (the wallet is not theirs), e.g. “OK”.
(Empty - no default set)
If wallet ownership verification is enabled in your AML/KYC settings, this message is shown after the customer presses “no” (the wallet is not theirs),
e.g. “Transaction aborted. We cannot send Bitcoin to wallets outside your control.”
(Empty - no default set)
If wallet ownership verification is enabled in your AML/KYC settings, this text is shown on button: “No”.
After pressing this button, the customer moves on to display the “no_flow” messages:
If wallet ownership verification is enabled in your AML/KYC settings, this text is shown on button: “Yes”.
After pressing this button, the customer moves forward (as usual) to the transaction.
(Empty - no default set)
If wallet ownership verification is enabled in your AML/KYC settings, this message is shown when the customer must confirm wallet ownership, e.g. “DO YOU CONTROL THE TARGET WALLET?”
This screen title is shared between this screen, and the “no_flow” screens.
(Empty - no default set)
When your customer chooses to have a voice call instead of an SMS, delay the call for “X” minutes.
15 |
We are sorry. You must be at least {minimumAge} years old to use this service. |
Specify the message that will appear on-screen during the sell flow when your customer reaches maximum available cash for dispensing from the BATM.
(Empty - no default set)
Field | Description | Applies to: |
---|---|---|
{bmp.address} | A QR-coded wallet address. | BUY |
{bmp.logo} | Your logo from Sprites (or GB). | All |
{bmp.paymentrequest} | The QR-coded SELL offer. | SELL |
{bmp.privatekey} | A QR-coded private key. | BUY |
{cryptosetting.name} | The Crypto Setting associated with the transaction. | BUY, SELL |
{identity.firstname} | The FIRST name from the related Identity. | BUY, SELL |
{identity.lastname} | The LAST name from the related Identity. | BUY, SELL |
{text.crypto.amount} | The amount of coin involved. | All |
{text.crypto.currency} | The type of coin (BTC/LTC/etc). | All |
{text.crypto.destination} | The wallet presented during the BUY. | BUY |
{text.crypto.rate} | The calculated rate based on the amount involved, your percentages, and fees. | All |
{text.crypto.rateNoFees} | Cryptocurrency Rate Without Fees | BUY, SELL |
{text.crypto.rateSpread} | Spread Between Rates in Fiat Currency
| BUY, SELL |
{text.fiat.amount} | The fiat amount of this transaction.; | All |
{text.fiat.currency} | The fiat (USD/EUR/etc) used. | All |
{text.fiat.fee.fixed} | Any flat fee assessed. | All |
{text.fiat.fee.total} | Total Fee in Fiat Currency | BUY, SELL |
{text.otp} | The OTP sent to a Customer. | OTP |
{text.privatekey} | The text version of any private key when a hard-copy is chosen by the customer. | BUY |
{text.time} | Transaction time at location. | All |
{text.transaction.expirationTimestamp} | The expiration datetime of the SELL offer. | ALL |
{text.transaction.id} | The RID of the transaction. | All |
{text.transaction.uuid | This ID links a WITHDRAW to this SELL. | SELL |
{text.transaction.related.id} | The ID of the associated SELL. | WITHDRAW |
Custom String | Permitted Fields |
---|---|
sms_buy_crypto_ticket_template | {text.time} {text.fiat.fee.total} |
sms_sell_crypto_ticket_template | {text.time} {text.fiat.fee.total} |
email_buy_crypto_ticket_template | {text.time} {text.fiat.fee.total} |
printer_paper_wallet_template | {text.address} |
printer_buy_crypto_ticket_template | {text.time} {text.fiat.fee.total} |
printer_sell_crypto_ticket_template | {bmp.logo} {text.fiat.fee.total} |
printer_withdrawal_ticket_template | {bmp.logo} |
printer_pos_crypto_ticket_template | {bmp.logo} |
sell_withdrawal_ready | {text.transaction.id} |
sell_invalid_payment | |
sell_timed_out | |
sell_arriving |
Special configuration strings
|
Setting | Description |
---|---|
acceptanceProblemRejectThreshold=X | Terminals will report the event “Acceptance Problem” after 3 failed attempts to accept a banknote (default).
|
alarm_delay_seconds=xx | alarm arming delay after closing the door (door sensors required). |
alarm_pin=abcd | Assign a numerical PIN for disarming the alarm.
|
alt-admin-access |
|
btc_reject_bc1 | Rejects customer SegWit wallet addresses ("bc1"). |
checkpin=abcd | Terminal will ask for numerical PIN before purchase.
|
datasaving | Decreases the “ping” frequency
|
idledatasaver | reduces the ping period in screensaver mode to 150 sec |
ltc_reject_ltc1 | Rejects customer wallet addresses beginning with ("ltc1"). |
paperwalletonly | Force paper wallet usage (required in certain jurisdictions.
|
rebootIntervalMinutes= | Changes the "no connection" timeout.
|
ukraine | Adds aid option for Ukraine, see: https://generalbytes.atlassian.net/l/cp/HWrVFiV0 |
-Xbitflyer=1 | Enables BitFlyer |
experimental | (deprecated) Implements the new (experimental) Terminal UI. |
legacy | (deprecated) Implements the old (legacy) Terminal UI. |