Account.md

Account

Properties

Name	Type	Description	Notes
id	String	ID of Account	[optional]
name	String	Display name of an account. Is expected to be unique across Noory and URL Safe so can not contain spaces or any other characters not suitable in URLS. This value is not only required but has to be lot less than 3 chars in length and not more than 10.	[optional]
businessName	String	The publicly visible, human readable name of the business running this account.	[optional]
businessEmail	String	Business Email address.	[optional]
businessPhone	String	Business phone number.	[optional]
businessAddress	String	Business Address	[optional]
businessUrl	String	Website of the business running the account if available	[optional]
businessLogo	String	Base64 encoded logo of the business if available	[optional]
country	CountryEnum	Two letter ISO country code of the country that the account is allowed to operate in e.g SL.	[optional]
defaultCurrency	DefaultCurrencyEnum	Three-letter ISO code for the default currency to associate with this Account. If charges or payments requests are created and no currency specified, this default currency is used. Should be a currency supported by noory. See {link} for a list of currencies supported by Noory	[optional]
sources	List<Source>	Payment sources, banks/mobile money, associated with this account. Used to push payouts to account.	[optional]
timezone	String	Timezone associated with account.	[optional]
hookEndpoint	String	Endpoint to which to send event notifications. Depending on the value of hookDeliveryMediumcan be either a valid phone identifier, https url, or email address	[optional]
hookEndpointSecret	String	Authorization token included as the Authorization Header if delivery medium is URL	[optional]
hookDeliveryMedium	HookDeliveryMediumEnum	Medium via which events are sent to account	[optional]
events	List<EventsEnum>	Event types that user wishes to be notified of. For a list of valid values call GET /events/types	[optional]
verification	AccountVerification		[optional]
locale	String	Locale for the account, important for providing information in the local language of the account.	[optional]
payoutSchedule	PayoutSchedule		[optional]
metadata	Object	Used to store Arbitrary data	[optional]
active	Boolean	Account is active	[optional]
deleted	Boolean	Account record has been soft deleted	[optional]
created	String	Date on which account was created	[optional]
modified	String	Date on which account was modified	[optional]

Enum: CountryEnum

Name	Value
SL	"SL"

Enum: DefaultCurrencyEnum

Name	Value
SLL	"SLL"

Enum: HookDeliveryMediumEnum

Name	Value
SMS	"sms"
WEBHOOK	"webhook"
EMAIL	"email"

Enum: List<EventsEnum>

Name	Value
TRANSACTION_RECEIVED	"transaction.received"
CHARGE_SUCCEEDED	"charge.succeeded"
CHARGE_SUCCEEDED_PARTIAL	"charge.succeeded.partial"
CHARGE_FAILED	"charge.failed"
CHARGE_CANCELED	"charge.canceled"
CHARGE_CREATED	"charge.created"
CHARGE_REQUEUE	"charge.requeue"
CHARGE_REQUESTED	"charge.requested"
CHARGE_REFUNDED	"charge.refunded"
CUSTOMER_CREATED	"customer.created"
CUSTOMER_DELETED	"customer.deleted"
CUSTOMER_UPDATED	"customer.updated"
CUSTOMER_SUBSCRIPTION_CREATED	"customer.subscription.created"
CUSTOMER_SUBSCRIPTION_DELETED	"customer.subscription.deleted"
CUSTOMER_SUBSCRIPTION_CHARGED	"customer.subscription.charged"
CUSTOMER_SUBSCRIPTION_UPDATED	"customer.subscription.updated"
CUSTOMER_SUBSCRIPTION_ENDED	"customer.subscription.ended"
PAYOUT_CANCELED	"payout.canceled"
PAYOUT_CREATED	"payout.created"
PAYOUT_FAILED	"payout.failed"
PAYOUT_PAID	"payout.paid"
PAYMENT_UPDATED	"payment.updated"
PAYMENT_CANCELED	"payment.canceled"
PAYMENT_CREATED	"payment.created"
PAYMENT_FAILED	"payment.failed"
PAYMENT_SUCCEEDED	"payment.succeeded"
ACCOUNT_CASHIN	"account.cashin"
ACCOUNT_CASHOUT	"account.cashout"
ACCOUNT_DEACTIVATED	"account.deactivated"
ACCOUNT_ACTIVATED	"account.activated"