Auto-generated unique identifier of the merchant.
Auto-generated numeric identifier of the merchant. This identifier is merchant facing and is usually included in all communications to the merchant.
The type of the merchant. Supported values are
The merchant's official and legally registered name.
The merchant's trading name that is usually displayed at the business's physical property.
First line of address. Max of 100 characters.
Second line of address. Max of 100 characters.
Town or city of address. Max of 100 characters.
Two letter ISO 3166-1 alpha-2 country code.
The postal code of the address. Max of 20 characters
The state of the address. Max of 100 characters
Two letter ISO 3166-1 alpha-2 country code.
The correspondence email of the merchant.
The merchant's reference code.
The contact number of the merchant that can be a mobile or landline number.
The billing status of the merchant. Supported values are:
true - Merchant billing runs are enabled. Payment transactions on invoices will be processed every billing cycle.
false - Merchant billing runs are disabled. No payment transactions will occur.
The merchant category classification code (MCC). A four-digit number assigned to a business by credit card companies when the business first starts accepting one of these cards as a form of payment.
The settlement status of the merchant. Supported values are:
true - Merchant settlement runs are enabled. Settlment transactions will be processed every settlement cycle.
false - Merchant settlement runs are disabled. No settlement transactions will occur.
The status of the merchant. Supported values are:
inactive - Merchant has been created but has not been verified by risk checking.
pending_risk_check - Merchant is currently undergoing risk checking.
active - Merchant has successfully passed risk checking and has full access to all functionality.
The merchant's settlements schedule details.
Specifies frequency of settlement. Valid values are
month. If no value is provided, the default value is
Specifies the number of intervals in settlement frequency. For example
intervalUnit="week" would means billing every 2 weeks. If no value is provided, the default value is 1.
Specifies the day the settlement schedule runs for the merchant.
Note: Settlement schedules can run on weekends but, depending on the payment provider, settlements may only get processed on the next working day.
intervalUnit = "day", then no value required.
intervalUnit = "week", then supported values are
monday, tuesday, wednesday, thursday, or
intervalUnit = "month", then supported values are numbers between 1 to 31. If the value specified is 29, 30 or 31 and the next month does not have these dates, it will automatically be rounded to the last day of the month.
Auto-generated date for next settlement date.
Specifies whether the next settlement date is calculated based on on calendar day or business day. This takes effect only if the
day. Valid values are
calendar. If no value is provided, the default value is
The merchant's official business registration number.
The merchant's payment method details that receives the settlement payout.
Auto-generated unique identifier of the merchant that the card token is associated to.
Auto-generated unique identifier of the payment method token generated by vault.
The bank details of the token.
The account holder's name . Max 50 characters.
Identifying number of the bank. Country specific rules.
Identifying number for a bank branch. Max of 4 digits for New Zealand.
The last 4 digits of the bank account number. Full account number is not displayed for security reasons.
Only required by New Zealand Banks. Must be between 2-3 digits.
The list of accepted payment methods supported. Supported values are
The merchant's tax identification used for tax reporting purposes.
The failed payment settings that are applied to past due invoices.
The initial action taken when a failed payment occurs. Supported values are:
stop - Do not attempt any further payment processing for the failed invoice.
continue - Continue to attempt payment recovery for the failed invoice.
Determines if automatic payment retry will occur on the failed invoice. Supported values are
Specifies the number of days to wait before next retry for payment. Supported values are between 2 - 14. Default value is 7.
Specifies the maximum number of failed attempts allowed before stopping payment retries. Supported values are between 2 - 5. Default value is 2.
The merchant's website address.
Brief additional description of the merchant such as their slogan.
The reactivation settings applied to a merchant.
Tax applied to all tax options under the merchant such as within invoices and plans.
Tax rate in percentage format. Supported values are from 0 to 99.99.
The merchant's fee pricing plan id
Notification setting of the merchant.
Customer email notification settings
Flag to turn on notification for Past due invoice
Flag to turn on notification for Payment method creation
Flag to turn on notification for Subscription creation
Additional data about the merchant object using key/value pairs format.