Custom Strings

Open

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.

California § 3905 Compliance guide: https://generalbytes.atlassian.net/wiki/x/EQA6tg?atlOrigin=eyJpIjoiYjAzYzhkOTM0OWM1NGQwMzljNGZlNmJkY2I3NzZiZTUiLCJwIjoiYyJ9

Definitely change these strings!

The following custom strings require your [Name, Address, Phone, etc], so change them now so that your customers can contact you in the event of a problem:

• printer_buy_crypto_ticket_template

• email_buy_crypto_ticket_template

• printer_sell_crypto_ticket_template

• printer_withdrawal_ticket_template

• printer_buy_crypto_ticket_transaction_failed_template

Quick jump to section:

Alphabetical Listing

Expand by clicking the “>” below.

Field types are represented by these prefixes:

"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. 

The following HTML formatting fields may be used in certain strings:

• <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)

CUSTOM STRINGS (CAS view)

Unsorted, this list is presented in the same order as seen on the CAS Terminal Settings page.

• Scroll towards the top to expand a linked list in alphabetical order.

support_phone

The phone number displayed on your BATM screen for support.

^{(Empty - no default set)}

registration_delay

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.

sell_success_timeout

After these # minutes, the “sell success” screen on the BATM will return to the main/normal screen.

printer_paper_wallet_template

This is printed when a paper wallet is chosen.

printer_buy_crypto_ticket_template

The paper BUY receipt contents are set here.

printer_buy_crypto_lnurl_ticket_template

When a Lightning BUY is prepared, this ticket will be printed.

printer_order_crypto_ticket_template

Sets the contents of a printed a ticket for a deposit/order. See https://generalbytes.atlassian.net/wiki/x/AYABzg

sms_buy_crypto_ticket_template

This SMS message is sent to customers after a BUY when using the optional SMS delivery.

• The maximum size for single custom SMS messages is 160 characters. Exceeding this limit may result in spam filtering & flagging.

sms_buy_crypto_lnurl_ticket_template

When a Lightning BUY is prepared, this ticket will be sent via SMS.

sms_buy_crypto_ticket_extension_template

When deploying your own extensions, this string can be set to utilize self-created variables.

^{(Empty - no default set)}

sms_order_crypto_ticket_template

Sets the contents of an SMS ticket for a deposit/order. See https://generalbytes.atlassian.net/wiki/x/AYABzg

email_buy_crypto_ticket_template

This email message is sent to customers after a BUY when using (optional) email delivery. Supports basic HTML tags.

email_buy_crypto_ticket_extension_template

When deploying your own extensions, this string can be set to utilize self-created variables.

^{(Empty - no default set)}

email_buy_crypto_lnurl_ticket_template

Customize the email message sent during a Lightning transaction.

email_order_crypto_ticket_template

Sets the contents of an emailed ticket for a deposit/order. See https://generalbytes.atlassian.net/wiki/x/AYABzg

printer_sell_crypto_ticket_template

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.

email_sell_crypto_ticket_template

This email 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.

sms_sell_crypto_ticket_template

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.

• 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.

• The maximum size for single custom SMS messages is 160 characters. Exceeding this limit may result in spam filtering & flagging.

email_cashback_ticket_template

This message is sent to a customer to permit a manually-created redemption (REDEEM) transaction. The message includes a REDEEM QR code.

printer_withdrawal_ticket_template

This paper SELL receipt is printed by the BATM after the fiat has been withdrawn by the customer.

email_withdrawal_ticket_template

This receipt is emailed to the customer after the fiat has been withdrawn.

sms_withdrawal_ticket_template

This receipt is sent via SMS to the customer after the fiat has been withdrawn.

printer_buy_crypto_ticket_transaction_failed_template

If a BUY transaction fails, the paper receipt contents are set here.

terms_and_conditions

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)}

scam_disclaimer

See these details: Scam Disclaimer

^{(Empty - no default set)}

sell_withdrawal_ready

This SMS communicates that the SELL is ready for customer withdrawal.

• The maximum size for single custom SMS messages is 160 characters. Exceeding this limit may result in spam filtering & flagging.

sell_invalid_payment

This SMS notifies your customer that the wrong amount has been submitted to the wallet specified in the Custom String: printer_sell_crypto_ticket_template.

• The maximum size for single custom SMS messages is 160 characters. Exceeding this limit may result in spam filtering & flagging.

sell_timed_out

This SMS notifies your customer that your SELL offer has expired, and the payment was not received within the required time limit.

• The maximum size for single custom SMS messages is 160 characters. Exceeding this limit may result in spam filtering & flagging.

sell_arriving

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).

• The maximum size for single custom SMS messages is 160 characters. Exceeding this limit may result in spam filtering & flagging.

alternative_welcome_message

Replaces the default: "Welcome to Bitcoin ATM".

^{(Empty - no default set)}

alternative_buy_message

Replaces the default: "Buy Bitcoins" on the main screen

^{(Empty - no default set)}

alternative_screensaver_message

Replaces the default: "BUY BITCOINS!" on the screensaver

^{(Empty - no default set)}

special_configuration

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.

buy_transaction_failed_additional_message

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)}

buy_transaction_success_additional_message

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)}

sell_transaction_failed_additional_message

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)}

buy_prepare_transaction_failed_blacklisted_message

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)}

buy_prepare_transaction_failed_high_risk_scoring_message

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)}

withdraw_transaction_failed_not_enough_cash_message

Replaces the default “Withdrawal is not possible. Not enough cash in the machine.” message.

^{(Empty - no message set)}

withdraw_transaction_failed_additional_message

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)}

sms_otp

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 maximum size for single custom SMS messages is 160 characters. Exceeding this limit may result in spam filtering & flagging.

custom_buy_limit_title

The BUY LIMIT title used during the chooseLimitScreen BUY flow.

^{(Empty - no default set)}

custom_buy_limit_description

The BUY LIMIT description used during the chooseLimitScreen BUY flow.

^{(Empty - no default set)}

custom_buy_fixed_fee_description

The BUY LIMIT fixed fee description used during the chooseLimitScreen BUY flow.

^{(Empty - no default set)}

custom_sell_limit_title

The SELL LIMIT title shown during the chooseLimitScreen SELL flow.

^{(Empty - no default set)}

custom_sell_limit_instruction

A SELL LIMIT subheading (e.g. “choose X”) shown during the chooseLimitScreen SELL flow.

^{(Empty - no override set)}

custom_sell_limit_description

The SELL LIMIT description shown during the chooseLimitScreen SELL flow.

^{(Empty - no default set)}

buy_anonymous_limit_alternative_message

Displays a custom Anonymous tier message on the BUY Choose Limit Screen button.

^{(Empty - no default set)}

buy_unregistered_limit_alternative_message

Displays a custom Not Registered tier message on the BUY Choose Limit Screen button.

^{(Empty - no default set)}

buy_registered_limit_alternative_message

Displays a custom Registered tier message on the BUY Choose Limit Screen button.

^{(Empty - no default set)}

sell_anonymous_limit_alternative_message

Displays a custom Anonymous tier message on the SELL Choose Limit Screen button.

^{(Empty - no default set)}

sell_unregistered_limit_alternative_message

Displays a custom Not Registered tier message on the SELL Choose Limit Screen button.

^{(Empty - no default set)}

sell_registered_limit_alternative_message

Displays a custom Registered tier message on the SELL Choose Limit Screen button.

^{(Empty - no default set)}

pep_rejected_info

Displayed to customers that are rejected due to PEP restrictions.

registrations_disabled

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). Links are supported.

Example: Please register at: {link}register.yourcasdomain.com{/link}

Default:

custom_registration_title

Displays a custom title for the “Are you registered?” screen.

^{(Empty - no default set)}

customer_unregistered

This SMS message will be sent to the Identity because their ID document expired.

• The maximum size for single custom SMS messages is 160 characters. Exceeding this limit may result in spam filtering & flagging.

custom_pep_question

This may be customized to comply with jurisdictional requirements.

^{(Empty - no default set)}

printer_cash_collection_ticket_template

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)}

registration_submitted_successfully_additional_message

Shown to the customer after successfully uploading the required registration documents.

^{(Empty - no default set)}

marketing_opt_in_agreement_text

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:

1. this custom string must contain text,

2. the customer’s Identity must have a cellphone number,

3. the customer must not have previously opted-in to the marketing agreement.

marketing_opt_in_agreement_title

Customize the title to the marketing opt-in agreement described above.

registration_submitted_successfully_custom_message