Merchant

A Merchant object represents your business and the associated configuration in Ansa.

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 stores configuration details of your closed-loop program.

Field	Type	Description	Example value
`appReloadConfig`	`object`	The App Reload object containing details about the reload options available to customers.
`autoReloadConfig`	`object`	The Auto reload object containing details about the merchant's default auto reload settings, and allowed minimum and maximum amounts.
`omsProvider`	`string`	The order management software provider	`square`
`paymentProcessor`	`string`	The payment processor	`stripe`
`userReferralConfig`	`object`	The User referral object containing details about user referral configuration

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

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`

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

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`

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

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`