A Merchant object represents your business and it's configurations in Ansa.
Amounts are integers
All
amountparameters and returned values are integers. These amounts represent the lowest denomination of the provided currency code, such as cents for USD. For example,"amount": 1000would indicate an amount of $10.00.
Merchant Attributes
| Field | Type | Description | Example value |
|---|---|---|---|
id | string | Unique identifier for the merchant. | 2aa3d415-8256-4d0e-97a1-7cd0a09e0230 |
metadata | object | Metadata object containing details about the merchant | |
name | string | The merchant's name | ansa merchant |
Metadata Attributes
The Merchant object has an associated metadata object that will also be returned when you request the Merchant.
| Field | Type | Description | Example value |
|---|---|---|---|
appReloadConfig | object | App Reload object containing details about the merchant reload options | |
autoReloadConfig | object | Auto reload object containing details about the merchant's auto reload settings | |
omsProvider | string | The OMS (order management software) provider | square |
paymentProcessor | string | The payment processor | stripe |
promotions | object | Promotions object containing details about promotions | |
userReferralConfig | object | User referral object containing details about user referral configurations |
Auto reload attributes
| Field | Type | Description | Example value |
|---|---|---|---|
minimumAutoReloadThreshold | integer | The minimum balance required in the customers' wallets before the auto-reload is triggered. If the user balance is below this threshold, the reload amount defined by the user will be added to their balance. | 1000 |
minimumAutoReloadAmount | integer | The lowest amount that a customer can choose to reload to their balance | 1000 |
maximumAutoReloadAmount | integer | The maximum amount of money that customers can choose to reload to their balance. Customers cannot choose the reload amount that is greater than the reload maximum set. | 1000 |
App reload attributes
| Field | Type | Description | Example value |
|---|---|---|---|
presetAmounts | object | The preset reload options shown to the client. At most one object in the array will have isMostPopular set to true. | [ { "id": "preset_1", "amount": 1000, "isMostPopular": true }, { "id": "preset_2", "amount": 2500, "isMostPopular": false }, { "id": "preset_3", "amount": 5000, "isMostPopular": false } ] |
allowCustomAmount | boolean | Toggle for clients' to allow custom reload amounts | true |
Promotions attributes
| Field | Type | Description | Example value |
|---|---|---|---|
type | string | Promotion type. Can be one of:first_top_upAdd funds to the user's wallet once on their first balance add. once_per_tierAdd funds to the user's wallet only once per tier. tieredAdd funds to the user's wallet each time they add balance, provided they meet the minimum transaction requirements. | first_top_up |
rewardTiers | object | Promotions can have multiple tiers, each with its own minimum transaction requirement. The Ansa platform automatically identifies and applies the highest reward tier for which a user qualifies.minTransactionRequirementThis is the minimum "add balance" amount that is eligible for a reward. promotionAmountThe promotional bonus added to the user's balance. | [ { "minTransactionRequirement": 2000, "promotionAmount": 500 }, { "minTransactionRequirement": 5000, "promotionAmount": 1500 } ] |
User referral attributes
| Field | Type | Description | Example value |
|---|---|---|---|
enabled | boolean | If true, user referral's are enabled | true |
redemptionEvent | string | Either add_balance or create_user. This determines which event triggers the user referral bonus. | add_balance |
redemptionThresholdAmount | integer | Only applies if redemptionEvent is add_balance. This is the minimum value required to trigger the user referral bonus | 100 |
senderCreditAmount | integer | The user referral bonus for the user who is doing the referral | 100 |
recipientCreditAmount | integer | The user referral bonus for the user who is claiming a referral | 100 |