Stores

Stores are are conceptual entities used to categorize transactions and hold different configuration options for making transactions. They can be used to represent a single or a group of sales terminals, online channels or sales persons, depending on the needs of your business model. Any transaction token that is made will be linked to a store via an application token.

The store object

Fields
idUUID
The UUID to identify the merchant and commonly refered to as merchantId.
namestring
The name of the merchant.
emailstring
The email of the merchant.
verifiedboolean
Whether the merchant has been verified.
created_onstring (ISO-8601)
Date the merchant was created on.
configuration.percent_feenumber
The percentage fee per transaction on this store as defined in the transaction fees section.
configuration.flat_feesnumber
The flat fee per transaction on this store as defined in the transaction fees section.
configuration.logo_urlstring
The default logo url.
configuration.countrystring
The country this store is based on. Affects what are considered ‘foreign’ cards.
configuration.languagestring
The default language.
configuration.display_time_zonestring
The default display time zone.
configuration.min_transfer_payoutstring
The minimum amount of funds accumulated before a transfer is made to the registered bank account.
configuration.maximum_charge_amountsstring
The default maximum charge amount that is accepted.
configuration.user_transactions_configuration.enabledboolean
Sends an email to the merchant on a transaction
configuration.user_transactions_configuration.notify_customerboolean
Sends customers an email on transaction
configuration.card_configuration.enabledboolean
Whether cards are enabled as a payment method on this store.
configuration.card_configuration.debit_enabledboolean
Whether debit cards are accepted.
configuration.card_configuration.prepaid_enabledboolean
Whether credit cards are accepted.
configuration.card_configuration.forbidden_card_brandsarray[string]
A list of card brands that are not allowed for use by this store.
configuration.card_configuration.allowed_countries_by_iparray[string]
A list of countries whose IP addresses are not allowed to make charges.
configuration.card_configuration.foreign_cards_allowedboolean
Whether foreign cards are accepted. A foreign card is a card whose country is not the same as the store’s country.
configuration.card_configuration.fail_on_new_emailboolean
Whether to allow cards that have been previously used with a specific email address, be rejected if a different email address is used.
configuration.card_configuration.allow_empty_cvvboolean
Whether to enable CVV checking for card charges.
configuration.card_configuration.card_limit.amountnumber
The amount to limit per card for the defined duration.
configuration.card_configuration.card_limit.currencystring (ISO-4217)
The currency in ISO-4217 format.
configuration.card_configuration.card_limit.durationstring (ISO-8601)
The duration in which to compare with the amount.
configuration.qr_scan_configuration.enabledboolean
Whether QR codes are usable as a payment method on this store.
configuration.qr_scan_configuration.forbidden_qr_scan_gatewaysarray[string]
A list of payment gateways that will not be used for processing QR code payments.
configuration.convenience_configuration.enabledboolean
Whether convenience store payments are usable as a payment method on this store.
configuration.recurring_token_configuration.recurring_typestring
Type of recurring token avaliable for use. none – Not allowed, bounded – restricted to a defined time period defined as the usage_period parameter when creating a transaction token.
configuration.recurring_token_configuration.charge_wait_periodstring (ISO-8601)
Interval between the recurring token can be reused
configuration.recurring_token_configuration.card_charge_cvv_confirmation.enabledboolean
Whether CVV confirmations are required for this store when using recurring tokens.
configuration.recurring_token_configuration.card_charge_cvv_confirmation.thresholdarray[MoneyAmount]
The maximum amount in the default currency of the store can charge without triggering a CVV confirmation.
configuration.security_configuration.inspect_suspicious_login_afterstring (ISO-8601)
The time period after which suspicious logins notifications will be sent to the merchant.
configuration.security_configuration.refund_percent_limitnumber
The amount that is refundable as a percentage of the total charges made by the merchant.
configuration.security_configuration.limit_charge_by_card_configuration.quantity_of_chargesnumber
The number of charges that can be made within a period of time as specified by duration_window.
configuration.security_configuration.limit_charge_by_card_configuration.duration_windowstring (ISO-8601)
The duration in which the number of charges that can be made.
configuration.installments_configuration.enabledboolean
Whether installments are enabled.
configuration.installments_configuration.min_charge_amountnumber
The minimum charge amount per cycle in the default currency.
configuration.installments_configuration.max_payout_periodstring (ISO-8601)
The maximum length an installment can have.
configuration.installments_configuration.failed_cycles_to_cancelnumber
The number of failed charges before an installment is automatically canceled.
configuration.card_brand_percent_fees.visanumber
The percentage fee for Visa card charges.
configuration.card_brand_percent_fees.american_expressnumber
The percentage fee for American Express card charges.
configuration.card_brand_percent_fees.mastercardnumber
The percentage fee for MasterCard card charges.
configuration.card_brand_percent_fees.maestronumber
The percentage fee for Maestro card charges.
configuration.card_brand_percent_fees.discovernumber
The percentage fee for Discover card charges.
configuration.card_brand_percent_fees.jcbnumber
The percentage fee for JCB card charges.
configuration.card_brand_percent_fees.diners_clubnumber
The percentage fee for Diners Club card charges.
configuration.card_brand_percent_fees.union_paynumber
The percentage fee for Union Pay card charges.

MoneyAmount

Fields
amountnumber
The amount sans decimal point.
currencystring (ISO-4217)
The currency in ISO-4217 format.