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 | |
|---|---|
| id | UUID The UUID to identify the merchant and commonly refered to as merchantId. |
| name | string The name of the merchant. |
| string The email of the merchant. | |
| verified | boolean Whether the merchant has been verified. |
| created_on | string (ISO-8601) Date the merchant was created on. |
| configuration.percent_fee | number The percentage fee per transaction on this store as defined in the transaction fees section. |
| configuration.flat_fees | number The flat fee per transaction on this store as defined in the transaction fees section. |
| configuration.logo_url | string The default logo url. |
| configuration.country | string The country this store is based on. Affects what are considered ‘foreign’ cards. |
| configuration.language | string The default language. |
| configuration.display_time_zone | string The default display time zone. |
| configuration.min_transfer_payout | string The minimum amount of funds accumulated before a transfer is made to the registered bank account. |
| configuration.maximum_charge_amounts | string The default maximum charge amount that is accepted. |
| configuration.user_transactions_configuration.enabled | boolean Sends an email to the merchant on a transaction |
| configuration.user_transactions_configuration.notify_customer | boolean Sends customers an email on transaction |
| configuration.card_configuration.enabled | boolean Whether cards are enabled as a payment method on this store. |
| configuration.card_configuration.debit_enabled | boolean Whether debit cards are accepted. |
| configuration.card_configuration.prepaid_enabled | boolean Whether credit cards are accepted. |
| configuration.card_configuration.forbidden_card_brands | array[string] A list of card brands that are not allowed for use by this store. |
| configuration.card_configuration.allowed_countries_by_ip | array[string] A list of countries whose IP addresses are not allowed to make charges. |
| configuration.card_configuration.foreign_cards_allowed | boolean 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_email | boolean 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_cvv | boolean Whether to enable CVV checking for card charges. |
| configuration.card_configuration.card_limit.amount | number The amount to limit per card for the defined duration. |
| configuration.card_configuration.card_limit.currency | string (ISO-4217) The currency in ISO-4217 format. |
| configuration.card_configuration.card_limit.duration | string (ISO-8601) The duration in which to compare with the amount. |
| configuration.qr_scan_configuration.enabled | boolean Whether QR codes are usable as a payment method on this store. |
| configuration.qr_scan_configuration.forbidden_qr_scan_gateways | array[string] A list of payment gateways that will not be used for processing QR code payments. |
| configuration.convenience_configuration.enabled | boolean Whether convenience store payments are usable as a payment method on this store. |
| configuration.recurring_token_configuration.recurring_type | string 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_period | string (ISO-8601) Interval between the recurring token can be reused |
| configuration.recurring_token_configuration.card_charge_cvv_confirmation.enabled | boolean Whether CVV confirmations are required for this store when using recurring tokens. |
| configuration.recurring_token_configuration.card_charge_cvv_confirmation.threshold | array[MoneyAmount] The maximum amount in the default currency of the store can charge without triggering a CVV confirmation. |
| configuration.security_configuration.inspect_suspicious_login_after | string (ISO-8601) The time period after which suspicious logins notifications will be sent to the merchant. |
| configuration.security_configuration.refund_percent_limit | number 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_charges | number 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_window | string (ISO-8601) The duration in which the number of charges that can be made. |
| configuration.installments_configuration.enabled | boolean Whether installments are enabled. |
| configuration.installments_configuration.min_charge_amount | number The minimum charge amount per cycle in the default currency. |
| configuration.installments_configuration.max_payout_period | string (ISO-8601) The maximum length an installment can have. |
| configuration.installments_configuration.failed_cycles_to_cancel | number The number of failed charges before an installment is automatically canceled. |
| configuration.card_brand_percent_fees.visa | number The percentage fee for Visa card charges. |
| configuration.card_brand_percent_fees.american_express | number The percentage fee for American Express card charges. |
| configuration.card_brand_percent_fees.mastercard | number The percentage fee for MasterCard card charges. |
| configuration.card_brand_percent_fees.maestro | number The percentage fee for Maestro card charges. |
| configuration.card_brand_percent_fees.discover | number The percentage fee for Discover card charges. |
| configuration.card_brand_percent_fees.jcb | number The percentage fee for JCB card charges. |
| configuration.card_brand_percent_fees.diners_club | number The percentage fee for Diners Club card charges. |
| configuration.card_brand_percent_fees.union_pay | number The percentage fee for Union Pay card charges. |
MoneyAmount
| Fields | |
|---|---|
| amount | number The amount sans decimal point. |
| currency | string (ISO-4217) The currency in ISO-4217 format. |