Protocol Documentation

Table of Contents

Subscription.proto

Top

GrpcCreateSubscriptionRequest

Request payloads

FieldTypeLabelDescription
billingPlanGuid string

GrpcDowngradeSubscriptionRequest

FieldTypeLabelDescription
subscriptionGuid string

billingPlanGuid string

GrpcFetchCurrentSubscriptionRequest

GrpcFetchSubscriptionHistoryRequest

GrpcRequestSubscriptionCancellationRequest

FieldTypeLabelDescription
subscriptionGuid string

cancellationReason string

GrpcSubscriptionByGuidRequest

FieldTypeLabelDescription
subscriptionGuid string

GrpcSubscriptionListData

FieldTypeLabelDescription
records GrpcSubscriptionResponseData repeated

pagination PaginationMeta

GrpcSubscriptionListResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData GrpcSubscriptionListData

errors string repeated

GrpcSubscriptionResponse

Response payloads

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData GrpcSubscriptionResponseData

errors string repeated

GrpcSubscriptionResponseData

FieldTypeLabelDescription
guid string

planCode string

planName string

planVersion int32

type SubscriptionTypeGrpc

status SubscriptionStatusGrpc

startDate string

endDate string

trialEndDate string

nextBillingDate string

autoRenewal bool

cancellationRequestedDate string

cancellationReason string

currency string

currentBillingCycle int32

createdAt string

updatedAt string

GrpcUpgradeSubscriptionRequest

FieldTypeLabelDescription
subscriptionGuid string

billingPlanGuid string

SubscriptionStatusGrpc

Enumerations

NameNumberDescription
SUBSCRIPTION_STATUS_UNSPECIFIED 0

SUBSCRIPTION_STATUS_TRIAL 1

SUBSCRIPTION_STATUS_ACTIVE 2

SUBSCRIPTION_STATUS_SUSPENDED 3

SUBSCRIPTION_STATUS_CANCELLED 4

SUBSCRIPTION_STATUS_EXPIRED 5

SubscriptionTypeGrpc

NameNumberDescription
SUBSCRIPTION_TYPE_UNSPECIFIED 0

SUBSCRIPTION_TYPE_VERSIONED 1

SUBSCRIPTION_TYPE_DYNAMIC 2

SubscriptionServiceResource

Service definitions

Method NameRequest TypeResponse TypeDescription
CreateSubscription .GrpcCreateSubscriptionRequest .GrpcSubscriptionResponse

UpgradeSubscription .GrpcUpgradeSubscriptionRequest .GrpcSubscriptionResponse

DowngradeSubscription .GrpcDowngradeSubscriptionRequest .GrpcSubscriptionResponse

RequestSubscriptionCancellation .GrpcRequestSubscriptionCancellationRequest .GrpcSubscriptionResponse

FetchCurrentSubscription .GrpcFetchCurrentSubscriptionRequest .GrpcSubscriptionResponse

FetchSubscriptionByGuid .GrpcSubscriptionByGuidRequest .GrpcSubscriptionResponse

FetchSubscriptionHistory .GrpcFetchSubscriptionHistoryRequest .GrpcSubscriptionListResponse

Charge.proto

Top

GrpcChargeByCodeRequest

FieldTypeLabelDescription
code string

GrpcChargeIdentifierResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData string

GrpcChargePageResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

errors string repeated

responseData GrpcChargeResponsePageData

GrpcChargeQueryRequest

FieldTypeLabelDescription
name string

code string

incomeAccountCode string

currencyCode string

amount string

minCap string

maxCap string

pageNumber int32

pageSize int32

GrpcChargeResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

errors string repeated

responseData GrpcChargeResponseData

GrpcChargeResponseData

Response payloads

FieldTypeLabelDescription
name string

code string

active bool

penalty bool

defaultAmount double

appliesTo ChargeAppliesToGrpc

calculationType ChargeCalculationTypeGrpc

timeType ChargeTimeTypeGrpc

paymentMode ChargePaymentModeGrpc

currency string

feeInterval int32

frequency CbsFrequencyGrpc

minimumCap double

maximumCap double

GrpcChargeResponsePageData

FieldTypeLabelDescription
meta PaginationMeta

records GrpcChargeResponseData repeated

GrpcCreateChargeRequest

Request payloads

FieldTypeLabelDescription
name string

code string

incomeAccountCode string

currencyCode string

appliesTo ChargeAppliesToGrpc

chargeTimeType ChargeTimeTypeGrpc

chargeCalculationType ChargeCalculationTypeGrpc

amount double

penalty bool

chargePaymentMode ChargePaymentModeGrpc

feeOnMonthDay string

feeInterval int32

feeFrequency CbsFrequencyGrpc

minCap double

maxCap double

GrpcUpdateChargeRequest

FieldTypeLabelDescription
name string

code string

amount string

incomeAccountCode string

CbsFrequencyGrpc

NameNumberDescription
CBS_FREQUENCY_UNSPECIFIED 0

DAILY 1

WEEKLY 2

MONTHLY 3

YEARLY 4

ChargeAppliesToGrpc

Enumerations

NameNumberDescription
CHARGE_APPLIES_TO_UNSPECIFIED 0

LOAN 1

WALLET 2

CUSTOMER 3

SHARES 4

ChargeCalculationTypeGrpc

NameNumberDescription
CHARGE_CALCULATION_TYPE_UNSPECIFIED 0

FLAT 1

PERCENT_OF_AMOUNT 2

PERCENT_OF_AMOUNT_AND_INTEREST 3

PERCENT_OF_INTEREST 4

PERCENT_OF_DISBURSEMENT_AMOUNT 5

ChargePaymentModeGrpc

NameNumberDescription
CHARGE_PAYMENT_MODE_UNSPECIFIED 0

REGULAR 1

WALLET_TRANSFER 2

ChargeTimeTypeGrpc

NameNumberDescription
CHARGE_TIME_TYPE_UNSPECIFIED 0

SPECIFIED_DUE_DATE 2

WALLET_ACTIVATION 3

WALLET_CLOSURE 4

WITHDRAWAL_FEE 5

ANNUAL_FEE 6

MONTHLY_FEE 7

OVERDRAFT_FEE 10

WEEKLY_FEE 11

WALLET_NOACTIVITY_FEE 16

ChargeApplicationResourceGrpc

Service definitions

Method NameRequest TypeResponse TypeDescription
CreateCharge .GrpcCreateChargeRequest .GrpcChargeResponse

Creates a new charge configuration for a product or wallet.
FetchChargeByCode .GrpcChargeByCodeRequest .GrpcChargeResponse

FetchCharges .GrpcChargeQueryRequest .GrpcChargePageResponse

UpdateCharge .GrpcUpdateChargeRequest .GrpcChargeResponse

DeleteCharge .GrpcChargeByCodeRequest .GrpcChargeIdentifierResponse

Merchant.proto

Top

EncryptionParameterGrpc

FieldTypeLabelDescription
encryptionAlgorithm string

encryptionKey string

encryptionMode string

padding string

iv string

systemDefault string

MerchantBusinessProfileRequest

Merchant Profile Request payloads

FieldTypeLabelDescription
legalEntityName string

businessProductName string

country string

MerchantDependentTypeRequest

FieldTypeLabelDescription
dependentType string

MerchantSignupData

FieldTypeLabelDescription
guid string

emailAddress string

contactMobileNumbers string repeated

type string

status string

auth IdentityAuthGrpc

security SecurityParamsGrpc

onboarding OnboardingParamsGrpc

MerchantSignupRequest

Request payloads

FieldTypeLabelDescription
name string

emailAddress string

password string

securityCode string

MerchantSignupResponse

Response payloads

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData MerchantSignupData

errors string repeated

OnboardingParamsGrpc

FieldTypeLabelDescription
onboardingStep string

onboardingCompleted bool

SecurityParamsGrpc

FieldTypeLabelDescription
encryptionEnabled bool

channelId string

channelSecret string

channelName string

encryption EncryptionParameterGrpc

SelfDependentProfileRequest

FieldTypeLabelDescription
notes string

SemiDependentProfileRequest

FieldTypeLabelDescription
databaseEngine string

databaseHost string

databasePort int32

databaseName string

username string

password string

sslMode string

caCertificateUrl string

SolelyDependentProfileRequest

FieldTypeLabelDescription
billingPlanGuid string

MerchantAuthServiceResource

Method NameRequest TypeResponse TypeDescription
MerchantSignup .MerchantSignupRequest .MerchantSignupResponse

MerchantProfileServiceResource

Method NameRequest TypeResponse TypeDescription
MerchantBusinessProfileRegistration .MerchantBusinessProfileRequest .GrpcStringResponse

UpdateMerchantHostModel .MerchantDependentTypeRequest .GrpcStringResponse

SolelyDependentHostModelRegistration .SolelyDependentProfileRequest .GrpcStringResponse

SemiDependentHostModelRegistration .SemiDependentProfileRequest .GrpcStringResponse

SelfDependentHostModelRegistration .SelfDependentProfileRequest .GrpcStringResponse

Accounting.proto

Top

GrpcCreateGLAccountRequest

Request payload

FieldTypeLabelDescription
name string

glCode string

description string

manualEntriesAllowed bool

parentId int64

type GrpcCbsGLAccountType

usage GrpcCbsGLUsageType

GrpcDeleteGLAccountRequest

FieldTypeLabelDescription
glCode string

GrpcFetchGLAccountByCodeRequest

FieldTypeLabelDescription
glCode string

GrpcGLAccountListData

FieldTypeLabelDescription
content GrpcGLAccountResponseData repeated

pagination PaginationMeta

GrpcGLAccountListResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData GrpcGLAccountListData

errors string repeated

GrpcGLAccountQueryRequest

FieldTypeLabelDescription
glCode string

type GrpcCbsGLAccountType

usage GrpcCbsGLUsageType

manualEntriesAllowed bool

parentId int64

pageNumber int32

pageSize int32

GrpcGLAccountResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData GrpcGLAccountResponseData

errors string repeated

GrpcGLAccountResponseData

Response payloads

FieldTypeLabelDescription
cbsId int64

description string

disabled bool

glCode string

manualEntriesAllowed bool

name string

decoratedName string

parentId int64

type GrpcCbsGLAccountType

usage GrpcCbsGLUsageType

GrpcUpdateGLAccountRequest

FieldTypeLabelDescription
guid string

description string

disabled bool

glCode string

manualEntriesAllowed bool

name string

parentId int64

type GrpcCbsGLAccountType

usage GrpcCbsGLUsageType

GrpcCbsGLAccountType

Enumerations

NameNumberDescription
CBS_GL_ACCOUNT_TYPE_UNSPECIFIED 0

ASSET 1

LIABILITY 2

EQUITY 3

INCOME 4

EXPENSE 5

GrpcCbsGLUsageType

NameNumberDescription
CBS_GL_USAGE_TYPE_UNSPECIFIED 0

DETAIL 1

HEADER 2

GLAccountServiceResource

Service definition

Method NameRequest TypeResponse TypeDescription
CreateGLAccount .GrpcCreateGLAccountRequest .GrpcGLAccountResponse

UpdateGLAccount .GrpcUpdateGLAccountRequest .GrpcGLAccountResponse

DeleteGLAccount .GrpcDeleteGLAccountRequest .GrpcStringResponse

FetchGLAccountByCode .GrpcFetchGLAccountByCodeRequest .GrpcGLAccountResponse

FetchGLAccounts .GrpcGLAccountQueryRequest .GrpcGLAccountListResponse

Wallet.proto

Top

GrpcBlockCreditWalletRequest

FieldTypeLabelDescription
walletGuid string

reasonForBlockCredit string

GrpcBlockDebitWalletRequest

FieldTypeLabelDescription
walletGuid string

reasonForBlockDebit string

GrpcBlockWalletRequest

FieldTypeLabelDescription
walletGuid string

reasonForBlock string

GrpcCloseWalletRequest

FieldTypeLabelDescription
walletGuid string

cbsCloseReason string

withdrawBalance bool

GrpcCreateWalletAndCustomerRequest

FieldTypeLabelDescription
firstName string

middleName string

lastName string

address string

dateOfBirth string

emailAddress string

mobileNumber string

customerType CustomerTypeGrpc

customerMetaData GrpcCreateWalletAndCustomerRequest.CustomerMetaDataEntry repeated

productCode string

entityCreationTrackingReference string

nominalAnnualInterestRate double

interestCompoundingPeriodType CbsPeriodTypeGrpc

interestCalculationType CbsCalculationTypeGrpc

interestCalculationDaysInYearType CbsCalculationDaysInYearTypeGrpc

minRequiredOpeningBalance double

withdrawalFeeForTransfers bool

allowOverdraft bool

withHoldTax bool

tags string repeated

metaData GrpcCreateWalletAndCustomerRequest.MetaDataEntry repeated

GrpcCreateWalletAndCustomerRequest.CustomerMetaDataEntry

FieldTypeLabelDescription
key string

value google.protobuf.Any

GrpcCreateWalletAndCustomerRequest.MetaDataEntry

FieldTypeLabelDescription
key string

value google.protobuf.Any

GrpcCreateWalletRequest

Request payloads

FieldTypeLabelDescription
customerId string

productCode string

entityCreationTrackingReference string

nominalAnnualInterestRate double

interestCompoundingPeriodType CbsPeriodTypeGrpc

interestCalculationType CbsCalculationTypeGrpc

interestCalculationDaysInYearType CbsCalculationDaysInYearTypeGrpc

minRequiredOpeningBalance double

withdrawalFeeForTransfers bool

allowOverdraft bool

withHoldTax bool

tags string repeated

metaData GrpcCreateWalletRequest.MetaDataEntry repeated

GrpcCreateWalletRequest.MetaDataEntry

FieldTypeLabelDescription
key string

value google.protobuf.Any

GrpcUnblockCreditWalletRequest

FieldTypeLabelDescription
walletGuid string

GrpcUnblockDebitWalletRequest

FieldTypeLabelDescription
walletGuid string

GrpcUnblockWalletRequest

FieldTypeLabelDescription
walletGuid string

GrpcWalletByAccountNumberRequest

FieldTypeLabelDescription
accountNumber string

GrpcWalletByCbsIdRequest

FieldTypeLabelDescription
cbsId int64

GrpcWalletListData

FieldTypeLabelDescription
records GrpcWalletResponseData repeated

GrpcWalletListResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

errors string repeated

responseData GrpcWalletListData

GrpcWalletPageData

FieldTypeLabelDescription
pagination PaginationMeta

records GrpcWalletResponseData repeated

GrpcWalletPageResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

errors string repeated

responseData GrpcWalletPageData

GrpcWalletResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

errors string repeated

responseData GrpcWalletResponseData

GrpcWalletResponseData

Response payloads

FieldTypeLabelDescription
guid string

cbsId int64

accountNumber string

cbsClientId int64

cbsClientName string

cbsProductId int64

productId string

cbsProductName string

submittedOn string

approvedOn string

currencyCode string

nominalAnnualInterestRate double

interestCompoundingPeriodType CbsPeriodTypeGrpc

interestPostingPeriodType CbsPeriodTypeGrpc

interestCalculationType CbsCalculationTypeGrpc

interestCalculationDaysInYearType CbsCalculationDaysInYearTypeGrpc

withdrawalFeeForTransfers bool

allowOverdraft bool

enforceMinRequiredBalance bool

lienAllowed bool

withHoldTax bool

isDormancyTrackingActive bool

status WalletStatusGrpc

accountBalance double

availableBalance double

tags string repeated

metaData GrpcWalletResponseData.MetaDataEntry repeated

GrpcWalletResponseData.MetaDataEntry

FieldTypeLabelDescription
key string

value google.protobuf.Any

GrpcWalletsByCustomerRequest

FieldTypeLabelDescription
customerId string

GrpcWalletsByMerchantRequest

FieldTypeLabelDescription
pageNumber int32

pageSize int32

WalletStatusGrpc

Enumerations

NameNumberDescription
WALLET_STATUS_UNSPECIFIED 0

WALLET_STATUS_PENDING 1

WALLET_STATUS_ACTIVE 2

WALLET_STATUS_ON_HOLD 3

WALLET_STATUS_CLOSED 4

WalletServiceResource

Service definitions

Method NameRequest TypeResponse TypeDescription
CreateWallet .GrpcCreateWalletRequest .GrpcWalletResponse

CreateWalletAndCustomer .GrpcCreateWalletAndCustomerRequest .GrpcWalletResponse

FetchWalletByAccountNumber .GrpcWalletByAccountNumberRequest .GrpcWalletResponse

FetchWalletByCbsId .GrpcWalletByCbsIdRequest .GrpcWalletResponse

FetchWalletsByCustomer .GrpcWalletsByCustomerRequest .GrpcWalletListResponse

FetchWalletsByMerchant .GrpcWalletsByMerchantRequest .GrpcWalletPageResponse

CloseWallet .GrpcCloseWalletRequest .GrpcWalletResponse

BlockWallet .GrpcBlockWalletRequest .GrpcWalletResponse

UnblockWallet .GrpcUnblockWalletRequest .GrpcWalletResponse

BlockCreditWallet .GrpcBlockCreditWalletRequest .GrpcWalletResponse

UnblockCreditWallet .GrpcUnblockCreditWalletRequest .GrpcWalletResponse

BlockDebitWallet .GrpcBlockDebitWalletRequest .GrpcWalletResponse

UnblockDebitWallet .GrpcUnblockDebitWalletRequest .GrpcWalletResponse

WalletProduct.proto

Top

GrpcCreateWalletProductRequest

Request payloads

FieldTypeLabelDescription
name string

productCode string

description string

currencyCode string

nominalAnnualInterestRate double

interestCompoundingPeriodType CbsPeriodTypeGrpc

interestPostingPeriodType CbsPeriodTypeGrpc

interestCalculationType CbsCalculationTypeGrpc

interestCalculationDaysInYearType CbsCalculationDaysInYearTypeGrpc

minRequiredOpeningBalance double

withdrawalFeeForTransfers bool

enforceMinRequiredBalance bool

allowOverdraft bool

withHoldTax bool

isDormancyTrackingActive bool

accountingRule CbsAccountingRuleTypeGrpc

savingsReferenceAccountCode string

overdraftPortfolioControlCode string

savingsControlAccountCode string

transfersInSuspenseAccountCode string

interestOnSavingsAccountCode string

writeOffAccountCode string

incomeFromFeeAccountCode string

incomeFromPenaltyAccountCode string

incomeFromInterestCode string

GrpcUpdateWalletProductRequest

FieldTypeLabelDescription
productCode string

name string

description string

nominalAnnualInterestRate double

interestCompoundingPeriodType CbsPeriodTypeGrpc

interestPostingPeriodType CbsPeriodTypeGrpc

interestCalculationType CbsCalculationTypeGrpc

interestCalculationDaysInYearType CbsCalculationDaysInYearTypeGrpc

minRequiredOpeningBalance double

withdrawalFeeForTransfers bool

enforceMinRequiredBalance bool

allowOverdraft bool

withHoldTax bool

isDormancyTrackingActive bool

accountingRule CbsAccountingRuleTypeGrpc

savingsReferenceAccountCode string

overdraftPortfolioControlCode string

savingsControlAccountCode string

transfersInSuspenseAccountCode string

interestOnSavingsAccountCode string

writeOffAccountCode string

incomeFromFeeAccountCode string

incomeFromPenaltyAccountCode string

incomeFromInterestCode string

GrpcWalletProductByCodeRequest

FieldTypeLabelDescription
productCode string

GrpcWalletProductPageData

FieldTypeLabelDescription
pagination PaginationMeta

records GrpcWalletProductResponseData repeated

GrpcWalletProductPageResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

errors string repeated

responseData GrpcWalletProductPageData

GrpcWalletProductQueryRequest

FieldTypeLabelDescription
pageNumber int32

pageSize int32

GrpcWalletProductResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

errors string repeated

responseData GrpcWalletProductResponseData

GrpcWalletProductResponseData

Response payloads

FieldTypeLabelDescription
code string

name string

description string

currencyCode string

nominalAnnualInterestRate double

interestCompoundingPeriodType CbsPeriodTypeGrpc

interestPostingPeriodType CbsPeriodTypeGrpc

interestCalculationType CbsCalculationTypeGrpc

interestCalculationDaysInYearType CbsCalculationDaysInYearTypeGrpc

withdrawalFeeForTransfers bool

allowOverdraft bool

overdraftLimit double

minRequiredBalance double

enforceMinRequiredBalance bool

maxAllowedLienLimit double

lienAllowed bool

nominalAnnualInterestRateOverdraft double

minOverdraftForInterestCalculation double

withHoldTax bool

accountingRule CbsAccountingRuleTypeGrpc

isDormancyTrackingActive bool

CbsAccountingRuleTypeGrpc

NameNumberDescription
CBS_ACCOUNTING_RULE_TYPE_UNSPECIFIED 0

CBS_ACCOUNTING_RULE_TYPE_NONE 1

CBS_ACCOUNTING_RULE_TYPE_CASH_BASED 2

CBS_ACCOUNTING_RULE_TYPE_ACCRUAL_PERIODIC 3

CBS_ACCOUNTING_RULE_TYPE_ACCRUAL_UPFRONT 4

CbsCalculationDaysInYearTypeGrpc

NameNumberDescription
CBS_CALCULATION_DAYS_IN_YEAR_TYPE_UNSPECIFIED 0

CBS_CALCULATION_DAYS_IN_YEAR_TYPE_ACTUAL 1

CBS_CALCULATION_DAYS_IN_YEAR_TYPE_DAYS_360 2

CBS_CALCULATION_DAYS_IN_YEAR_TYPE_DAYS_365 3

CBS_CALCULATION_DAYS_IN_YEAR_TYPE_DAYS_365_366 4

CbsCalculationTypeGrpc

NameNumberDescription
CBS_CALCULATION_TYPE_UNSPECIFIED 0

CBS_CALCULATION_TYPE_FLAT 1

CBS_CALCULATION_TYPE_DECLINING_BALANCE 2

CbsPeriodTypeGrpc

Enumerations

NameNumberDescription
CBS_PERIOD_TYPE_UNSPECIFIED 0

CBS_PERIOD_TYPE_DAYS 1

CBS_PERIOD_TYPE_WEEKS 2

CBS_PERIOD_TYPE_MONTHS 3

CBS_PERIOD_TYPE_YEARS 4

CBS_PERIOD_TYPE_WHOLE_TERM 5

WalletProductServiceResource

Service definitions

Method NameRequest TypeResponse TypeDescription
CreateWalletProduct .GrpcCreateWalletProductRequest .GrpcWalletProductResponse

UpdateWalletProduct .GrpcUpdateWalletProductRequest .GrpcWalletProductResponse

FetchWalletProductByCode .GrpcWalletProductByCodeRequest .GrpcWalletProductResponse

FetchWalletProducts .GrpcWalletProductQueryRequest .GrpcWalletProductPageResponse

Customer.proto

Top

GrpcCreateCustomerRequest

FieldTypeLabelDescription
firstName string

middleName string

lastName string

fullName string

address string

dateOfBirth string

emailAddress string

mobileNumber string

customerType CustomerTypeGrpc

metaData GrpcCreateCustomerRequest.MetaDataEntry repeated

GrpcCreateCustomerRequest.MetaDataEntry

FieldTypeLabelDescription
key string

value google.protobuf.Any

GrpcCustomerByGuidRequest

FieldTypeLabelDescription
guid string

GrpcCustomerByMerchantReferenceRequest

FieldTypeLabelDescription
merchantReference string

GrpcCustomerListData

FieldTypeLabelDescription
pagination PaginationMeta

records GrpcCustomerResponseData repeated

GrpcCustomerListResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData GrpcCustomerListData

errors string repeated

GrpcCustomerQueryParam

FieldTypeLabelDescription
status CustomerStatusGrpc

type CustomerTypeGrpc

emailAddress string

mobileNumber string

merchantReference string

startDate string

endDate string

firstName string

lastName string

middleName string

fullName string

pageNumber int32

pageSize int32

GrpcCustomerResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData GrpcCustomerResponseData

errors string repeated

GrpcCustomerResponseData

Response payloads

FieldTypeLabelDescription
guid string

identity string

firstName string

lastName string

middleName string

fullName string

emailAddress string

mobileNumber string

status CustomerStatusGrpc

type CustomerTypeGrpc

createdAt string

updatedAt string

lastRecordUpdateTime string

metaDataJson string

GrpcDeactivateCustomerRequest

FieldTypeLabelDescription
guid string

deactivateCustomerReason string

GrpcUpdateCustomerRequest

FieldTypeLabelDescription
guid string

firstName string

middleName string

lastName string

fullName string

dateOfBirth string

emailAddress string

mobileNumber string

metaData GrpcUpdateCustomerRequest.MetaDataEntry repeated

GrpcUpdateCustomerRequest.MetaDataEntry

FieldTypeLabelDescription
key string

value google.protobuf.Any

CustomerStatusGrpc

Request payloads

NameNumberDescription
CUSTOMER_STATUS_UNSPECIFIED 0

CUSTOMER_STATUS_PENDING 1

CUSTOMER_STATUS_ACTIVE 2

CUSTOMER_STATUS_DEACTIVATED 3

CUSTOMER_STATUS_CLOSED 4

CustomerTypeGrpc

NameNumberDescription
CUSTOMER_TYPE_UNSPECIFIED 0

INDIVIDUAL 1

BUSINESS 2

CustomerServiceResource

Service definitions

Method NameRequest TypeResponse TypeDescription
CreateCustomer .GrpcCreateCustomerRequest .GrpcCustomerResponse

UpdateCustomer .GrpcUpdateCustomerRequest .GrpcCustomerResponse

DeactivateCustomer .GrpcDeactivateCustomerRequest .GrpcCustomerResponse

ReactivateCustomer .GrpcCustomerByGuidRequest .GrpcCustomerResponse

CloseCustomer .GrpcCustomerByGuidRequest .GrpcCustomerResponse

FetchCustomerByGuid .GrpcCustomerByGuidRequest .GrpcCustomerResponse

FetchCustomerByMerchantReference .GrpcCustomerByMerchantReferenceRequest .GrpcCustomerResponse

FetchCustomers .GrpcCustomerQueryParam .GrpcCustomerListResponse

Resource.proto

Top

CountryDataGrpc

FieldTypeLabelDescription
name string

description string

countryCode string

phoneNumberPrefix string

baseCurrencyCode string

CountryListResponse

Response payloads

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData CountryDataGrpc repeated

errors string repeated

CurrencyDataGrpc

FieldTypeLabelDescription
name string

code string

description string

CurrencyListResponse

Response payloads

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData CurrencyDataGrpc repeated

errors string repeated

FetchCountriesRequest

Request payloads

FetchCurrenciesRequest

FetchTimeZonesRequest

TimeZoneDataGrpc

FieldTypeLabelDescription
name string

zoneId string

description string

TimeZoneListResponse

Response payloads

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData TimeZoneDataGrpc repeated

errors string repeated

ResourceServiceResource

Method NameRequest TypeResponse TypeDescription
FetchCountries .FetchCountriesRequest .CountryListResponse

FetchCurrencies .FetchCurrenciesRequest .CurrencyListResponse

FetchTimeZones .FetchTimeZonesRequest .TimeZoneListResponse

Admin.proto

Top

DeactivatePlatformUserRequest

FieldTypeLabelDescription
platformUserId string

EditPlatformUserRequest

FieldTypeLabelDescription
platformUserId string

emailAddress string

roleIds string repeated

roleGroupIds string repeated

designation string

metaData EditPlatformUserRequest.MetaDataEntry repeated

EditPlatformUserRequest.MetaDataEntry

FieldTypeLabelDescription
key string

value string

FetchPlatformUsersRequest

FieldTypeLabelDescription
startDate string

endDate string

status string

searchKey string

pageNumber int32

pageSize int32

FetchSinglePlatformUserRequest

FieldTypeLabelDescription
accountId string

emailAddress string

InvitePlatformUserRequest

FieldTypeLabelDescription
fullName string

emailAddress string

roleIds string repeated

roleGroupIds string repeated

designation string

metaData InvitePlatformUserRequest.MetaDataEntry repeated

InvitePlatformUserRequest.MetaDataEntry

FieldTypeLabelDescription
key string

value string

PermissionDataGrpc

FieldTypeLabelDescription
guid string

permission string

PlatformUserDataGrpc

FieldTypeLabelDescription
name NameGrpc

fullName string

emailAddress string

phoneNumber string

status string

category string

roles RoleDataGrpc repeated

roleGroups RoleGroupDataGrpc repeated

auth IdentityAuthGrpc

security SecurityParamsGrpc

onboarding OnboardingParamsGrpc

PlatformUserDataResponse

Response payloads - Supporting messages

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData PlatformUserDataGrpc

errors string repeated

PlatformUserListData

FieldTypeLabelDescription
content PlatformUserDataGrpc repeated

pagination PaginationMeta

PlatformUserListResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData PlatformUserListData

errors string repeated

PlatformUserLoginRequest

Request payloads

FieldTypeLabelDescription
accountId string

emailAddress string

password string

securityCode string

ReactivatePlatformUserRequest

FieldTypeLabelDescription
platformUserId string

ResetPlatformUserPasswordRequest

FieldTypeLabelDescription
accountId string

emailAddress string

securityCode string

newPassword string

RoleDataGrpc

FieldTypeLabelDescription
guid string

name string

description string

permissions PermissionDataGrpc repeated

RoleGroupDataGrpc

FieldTypeLabelDescription
guid string

name string

description string

roles RoleDataGrpc repeated

SetupPlatformUserRequest

FieldTypeLabelDescription
accountId string

emailAddress string

newPassword string

securityCode string

AdminMgtServiceResource

Method NameRequest TypeResponse TypeDescription
InvitePlatformUser .InvitePlatformUserRequest .PlatformUserDataResponse

EditPlatformUser .EditPlatformUserRequest .PlatformUserDataResponse

DeactivatePlatformUser .DeactivatePlatformUserRequest .GrpcStringResponse

FetchPlatformUsers .FetchPlatformUsersRequest .PlatformUserListResponse

SetupPlatformUser .SetupPlatformUserRequest .PlatformUserDataResponse

ReactivatePlatformUser .ReactivatePlatformUserRequest .PlatformUserDataResponse

AdminUserServiceResource

Method NameRequest TypeResponse TypeDescription
FetchAdminUser .FetchSinglePlatformUserRequest .PlatformUserDataResponse

LoginAdminUser .PlatformUserLoginRequest .PlatformUserDataResponse

ResetAdminPassword .ResetPlatformUserPasswordRequest .GrpcStringResponse

Common.proto

Top

GrpcStringResponse

FieldTypeLabelDescription
responseCode string

responseMessage string

responseData string

errors string repeated

IdentityAuthGrpc

FieldTypeLabelDescription
accessToken string

type string

tokenIssuedAt string

tokenExpiredAt string

NameGrpc

FieldTypeLabelDescription
firstName string

lastName string

PaginationMeta

FieldTypeLabelDescription
pageNumber int32

pageSize int32

pageCount int32

totalCount int32

numberOfPages int32

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)