PayPal

4. MERCHANT MODULE (UI prompt)

Module Entities (11)

Entity	Alias	Module	Global Schema
(1) Country	*Country*	CountryModule	PayPal
(2) Invoice	*Invoice*	CurrencyModule	PayPal
(3) Merchant	*Merchant*	MerchantModule	PayPal
(4) MerchantAddress	*MerchantAddress*	MerchantModule	PayPal
(5) MerchantApiCredential	*MerchantApiCredential*	MerchantModule	PayPal
(6) MerchantBusinessInfo	*MerchantBusinessInfo*	MerchantModule	PayPal
(7) MerchantWebsite	*MerchantWebsite*	MerchantModule	PayPal
(8) SecurityIncident	*SecurityIncident*	RegionModule	PayPal
(9) SubscriptionPlan	*SubscriptionPlan*	SubscriptionModule	PayPal
(10) Transaction	*Transaction*	TransactionModule	PayPal
(11) UserAccount	*UserAccount*	UserAccountModule	PayPal

Module Interfaces (31)

Remote Method	Local Method	Module	HTTP-Method	References
(1) /merchantbusinessinfo/{id}	*deleteMerchantBusinessInfoById(id)*	MerchantModule	*DELETE*	MerchantBusinessInfo
(2) /merchant/{id}	*findMerchantById(id)*	MerchantModule	*GET*	Merchant
(3) /merchantwebsite/{id}	*updateMerchantWebsiteById(merchantwebsite)*	MerchantModule	*PUT*	MerchantWebsite
(4) /merchantwebsite	*findAllMerchantWebsite()*	MerchantModule	*GET*	MerchantWebsite
(5) /merchant/{id}	*updateMerchantById(merchant)*	MerchantModule	*PUT*	Merchant
(6) /merchantaddress/{id}	*deleteMerchantAddressById(id)*	MerchantModule	*DELETE*	MerchantAddress
(7) /merchantaddress/{id}	*updateMerchantAddressById(merchantaddress)*	MerchantModule	*PUT*	MerchantAddress
(8) /merchantwebsite/{id}	*findMerchantWebsiteById(id)*	MerchantModule	*GET*	MerchantWebsite
(9) /merchantapicredential	*insertMerchantApiCredential(merchantapicredential)*	MerchantModule	*POST*	MerchantApiCredential
(10) /merchantapicredential	*findAllMerchantApiCredential()*	MerchantModule	*GET*	MerchantApiCredential
(11) /merchant	*findAllMerchant()*	MerchantModule	*GET*	Merchant
(12) /merchantbusinessinfo/merchant/{id}	*findAllMerchantBusinessInfoOfMerchant(id)*	MerchantModule	*GET*	Merchant MerchantBusinessInfo
(13) /merchantaddress/{id}	*findMerchantAddressById(id)*	MerchantModule	*GET*	MerchantAddress
(14) /merchantwebsite/merchant/{id}	*findAllMerchantWebsiteOfMerchant(id)*	MerchantModule	*GET*	Merchant MerchantWebsite
(15) /merchant	*insertMerchant(merchant)*	MerchantModule	*POST*	Merchant
(16) /merchantbusinessinfo	*insertMerchantBusinessInfo(merchantbusinessinfo)*	MerchantModule	*POST*	MerchantBusinessInfo
(17) /merchantbusinessinfo/{id}	*findMerchantBusinessInfoById(id)*	MerchantModule	*GET*	MerchantBusinessInfo
(18) /merchantbusinessinfo/{id}	*updateMerchantBusinessInfoById(merchantbusinessinfo)*	MerchantModule	*PUT*	MerchantBusinessInfo
(19) /merchantaddress/country/{id}	*findAllMerchantAddressOfCountry(id)*	MerchantModule	*GET*	Country MerchantAddress
(20) /merchantaddress	*findAllMerchantAddress()*	MerchantModule	*GET*	MerchantAddress
(21) /merchant/{id}	*deleteMerchantById(id)*	MerchantModule	*DELETE*	Merchant
(22) /merchantapicredential/merchant/{id}	*findAllMerchantApiCredentialOfMerchant(id)*	MerchantModule	*GET*	Merchant MerchantApiCredential
(23) /merchantwebsite	*insertMerchantWebsite(merchantwebsite)*	MerchantModule	*POST*	MerchantWebsite
(24) /merchant/useraccount/{id}	*findAllMerchantOfUserAccount(id)*	MerchantModule	*GET*	UserAccount Merchant
(25) /merchantapicredential/{id}	*deleteMerchantApiCredentialById(id)*	MerchantModule	*DELETE*	MerchantApiCredential
(26) /merchantaddress/merchant/{id}	*findAllMerchantAddressOfMerchant(id)*	MerchantModule	*GET*	Merchant MerchantAddress
(27) /merchantaddress	*insertMerchantAddress(merchantaddress)*	MerchantModule	*POST*	MerchantAddress
(28) /merchantwebsite/{id}	*deleteMerchantWebsiteById(id)*	MerchantModule	*DELETE*	MerchantWebsite
(29) /merchantbusinessinfo	*findAllMerchantBusinessInfo()*	MerchantModule	*GET*	MerchantBusinessInfo
(30) /merchantapicredential/{id}	*findMerchantApiCredentialById(id)*	MerchantModule	*GET*	MerchantApiCredential
(31) /merchantapicredential/{id}	*updateMerchantApiCredentialById(merchantapicredential)*	MerchantModule	*PUT*	MerchantApiCredential

4.1 MERCHANT

Merchant

MerchantModule

PayPal

Properties (7)

Property	Type	Entity	Reference	Module
*(1) Category*	*STRING*	Merchant
*(2) CreatedAt*	*DATE*	Merchant
*(3) DisplayName*	*STRING*	Merchant
*(4) LegalName*	*STRING*	Merchant
*(5) Status*	*STRING*	Merchant
*(6) UserAccount*	*LONG*	Merchant	UserAccount	UserAccountModule
*(7) WebsiteUrl*	*STRING*	Merchant

Example:

final Merchant merchant = (Merchant) invokeModule(MERCHANT_MODULE + "/merchant/" + id, Merchant.class);
if (merchant != null) {
    final UserAccount useraccount1 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + merchant.getUserAccount().getId(), UserAccount.class);
    if (useraccount1 != null) {
    }
}
return merchant;

4.2 MERCHANT ADDRESS

MerchantAddress

MerchantModule

PayPal

Properties (8)

Property	Type	Entity	Reference	Module
*(1) AddressType*	*STRING*	MerchantAddress
*(2) City*	*STRING*	MerchantAddress
*(3) Country*	*LONG*	MerchantAddress	Country	CountryModule
*(4) Line1*	*STRING*	MerchantAddress
*(5) Line2*	*STRING*	MerchantAddress
*(6) Merchant*	*LONG*	MerchantAddress	Merchant	MerchantModule
*(7) PostalCode*	*STRING*	MerchantAddress
*(8) State*	*STRING*	MerchantAddress

Example:

final MerchantAddress merchantaddress = (MerchantAddress) invokeModule(MERCHANT_MODULE + "/merchantaddress/" + id, MerchantAddress.class);
if (merchantaddress != null) {
    final Merchant merchant1 = (Merchant) invokeModule(MERCHANT_MODULE + "/merchant/" + merchantaddress.getMerchant().getId(), Merchant.class);
    if (merchant1 != null) {
        final UserAccount useraccount2 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + merchant1.getUserAccount().getId(), UserAccount.class);
        if (useraccount2 != null) {
        }
    }
    final Country country3 = (Country) invokeModule(COUNTRY_MODULE + "/country/" + merchantaddress.getCountry().getId(), Country.class);
    if (country3 != null) {
        final Region region4 = (Region) invokeModule(REGION_MODULE + "/region/" + country3.getRegion().getId(), Region.class);
        if (region4 != null) {
        }
    }
}
return merchantaddress;

4.3 MERCHANT API CREDENTIAL

MerchantApiCredential

MerchantModule

PayPal

Properties (6)

Property	Type	Entity	Reference	Module
*(1) ClientId*	*STRING*	MerchantApiCredential
*(2) ClientSecretHash*	*STRING*	MerchantApiCredential
*(3) CreatedAt*	*DATE*	MerchantApiCredential
*(4) LastUsedAt*	*DATE*	MerchantApiCredential
*(5) Merchant*	*LONG*	MerchantApiCredential	Merchant	MerchantModule
*(6) Status*	*STRING*	MerchantApiCredential

Example:

final MerchantApiCredential merchantapicredential = (MerchantApiCredential) invokeModule(MERCHANT_MODULE + "/merchantapicredential/" + id, MerchantApiCredential.class);
if (merchantapicredential != null) {
    final Merchant merchant1 = (Merchant) invokeModule(MERCHANT_MODULE + "/merchant/" + merchantapicredential.getMerchant().getId(), Merchant.class);
    if (merchant1 != null) {
        final UserAccount useraccount2 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + merchant1.getUserAccount().getId(), UserAccount.class);
        if (useraccount2 != null) {
        }
    }
}
return merchantapicredential;

4.4 MERCHANT BUSINESS INFO

MerchantBusinessInfo

MerchantModule

PayPal

Properties (5)

Property	Type	Entity	Reference	Module
*(1) EstablishedAt*	*DATE*	MerchantBusinessInfo
*(2) IndustryCode*	*STRING*	MerchantBusinessInfo
*(3) Merchant*	*LONG*	MerchantBusinessInfo	Merchant	MerchantModule
*(4) RegistrationNumber*	*STRING*	MerchantBusinessInfo
*(5) TaxNumber*	*STRING*	MerchantBusinessInfo

Example:

final MerchantBusinessInfo merchantbusinessinfo = (MerchantBusinessInfo) invokeModule(MERCHANT_MODULE + "/merchantbusinessinfo/" + id, MerchantBusinessInfo.class);
if (merchantbusinessinfo != null) {
    final Merchant merchant1 = (Merchant) invokeModule(MERCHANT_MODULE + "/merchant/" + merchantbusinessinfo.getMerchant().getId(), Merchant.class);
    if (merchant1 != null) {
        final UserAccount useraccount2 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + merchant1.getUserAccount().getId(), UserAccount.class);
        if (useraccount2 != null) {
        }
    }
}
return merchantbusinessinfo;

4.5 MERCHANT WEBSITE

MerchantWebsite

MerchantModule

PayPal

Properties (4)

Property	Type	Entity	Reference	Module
*(1) Merchant*	*LONG*	MerchantWebsite	Merchant	MerchantModule
*(2) Status*	*STRING*	MerchantWebsite
*(3) Url*	*STRING*	MerchantWebsite
*(4) VerifiedAt*	*DATE*	MerchantWebsite

Example:

final MerchantWebsite merchantwebsite = (MerchantWebsite) invokeModule(MERCHANT_MODULE + "/merchantwebsite/" + id, MerchantWebsite.class);
if (merchantwebsite != null) {
    final Merchant merchant1 = (Merchant) invokeModule(MERCHANT_MODULE + "/merchant/" + merchantwebsite.getMerchant().getId(), Merchant.class);
    if (merchant1 != null) {
        final UserAccount useraccount2 = (UserAccount) invokeModule(USER_ACCOUNT_MODULE + "/useraccount/" + merchant1.getUserAccount().getId(), UserAccount.class);
        if (useraccount2 != null) {
        }
    }
}
return merchantwebsite;