Multigate
Schemas
Copy Page
Multigate
🚀 Getting Started
🔓 Authentication
Get Token
Refresh Token
Logout User
Reset Password
Get Current User Info
👋 Onboarding
Create Subclient
Get All Subclients
Get Subclient
Update Subclient
Create Subclient Shareholder
Get Subclient Shareholders
Update Subclient Shareholder
Upload Subclient Documents
Get Subclient Documents
Delete Subclient
Submit Subclient
💰 Accounts
📄 Statements
V2
Get statement by account entity Id
Download statement by account entity Id
Get Statement
Download statement
Create Virtual Account
Get Account
Get Accounts By
Get All Accounts
Simulate Inflow (UAT only)
🔃 Conversions
Get Quote
Lock Rate
Get Trade
Get All Trades
💸 Payments
🏦 Banks
Get Bank Details
👤 Beneficiaries
Create Beneficiary
Get All Beneficiaries
Get Beneficiary
Update Beneficiary
Validate Beneficiary Account (NGN only)
Create Single Transfer
Get Purpose Codes
Get Transfer Fields & Fees
Find Transfers
📩 Webhooks / Push Notifications
Add a New Client Configuration
Update Client Configuration Current Mode
Get Client Configuration
📲 Remittance
Initiate Remittance
Get Remittance
Schemas
Sample Schemas
Pet
Category
Tag
Schemas
BeneficiaryOutput
BeneficiaryOutputArray
AccountsByOutput
SubClientApprovalInput
NewAccountOutput
NewAccountOutput Copy
LoginRequest
AccountInput
Bank
TransactionInflowInput
RemittanceResponse
TransactionHistoryDataOutput
FailedLoginAttemptResponse
ApprovalRequestOutputData
BankBranch
TransactionInflowOutput
RemittanceRequest
ClientLoginRequest
BeneficiaryInput
PaginatedBankResponse
AccountOutput
RefreshTokenRequest
ClientApprovalWorkflow
BulkTransferRequest
ErrorOutput
ReverifyMfaRequest
ClientConfigInput
BulkTransferResponse
LinkedAccountInput
verifyMfaRequest
CurrencyPartnerMappingInput
NameEnquiryQuery
ClientOutput
MFASetupRequest
DocumentOutputData
NameEnquiryResponse
UpdateAccountInput
resetMFARequest
ErrorOutputData
PaymentTypeMethodResponse
DisableAccountInput
RequestMFAResetRequest
CreatePartnerInput
PurposeCode
AccountBalanceOutput
ResetMFAByAdministratorRequest
PartnerClientMappingInput
ResponseBase
ConsolidatedAccountBalancesOutput
ForgotPasswordRequest
CreateProductSubscriptionInput
CreateRiskRuleDTO
ConsolidatedAccountOutput
ResetPasswordRequest
CreateProfileInput
UpdateRiskRuleDTO
ValidateSourceAccountOutput
ChangePasswordRequest
CreateShareHolderInput
RuleFilters
AccountOutputArray
UserReviewResponse
SubClientInput
RiskRule
IntermediaryBankInput
MbcReportOutput
User
RiskRuleResponse
BranchInformationInput
CreateUserRequest
RiskRulesResponse
ReviewApprovalRequest
SingleTransferRequest
BeneficiaryOutput
UserRolesUpdateReviewResponse
SingleTransferResponse
BeneficiaryOutputArray
UpdateUserRoleRequest
BeneficiaryDetails
UpdateBeneficiaryInput
UpdateUserRequest
IntermediaryBank
BeneficiaryLookUpInput
DeleteUserRequest
FeeConfiguredRequest
BeneficiaryLookUpOutput
EnableUserRequest
FeeConfiguredResponse
DisableUserRequest
PaymentMethodFieldMetadata
ClientPaymentCountries
DeleteRoleRequest
ReviewAlertRequest
TransferWorkFlowRequest
ShareholderDocumentOutputData
ClientBusinessStructure
UpdateUserPhoneNumberRequest
ConfigureClientScreeningOutput
TransactionAlert
ClientScreeningConfigOutput
ClientDocumentCheckList
ClientAutomatedScreeningInput
AssignUsersToRolesRequest
AlertResponse
ClientBusinessUser
UpdateRiskRatingInput
RemoveUsersFromRolesRequest
RiskReviewDecisionInput
AlertsResponse
ClientInput
UpdateUserClientRequest
PaginatedAlertResponse
ClientOutputData
UserClientsPendingApprovalResponse
AlertStatsResponse
UpdateClientInput
VerifyUserEmailRequest
Transaction
Client
TransactionFilter
ShareHolderOutputData
CreateClientRequest
PaginatedResponse
ShareHolderOutput
UpdateClientRequest
TransactionPerDay
ShareHolderOutputArray
ProductsToClientRequest
TransactionSummaryResponse
CreateMultipleShareHoldersInput
Role
UpdateShareHolderInput
Permission
TransactionMetrics
ClientOutputArray
GetPermissionResponse
ClientDocUploadInput
RolePermission
ClientDocUploadInputArray
CreateRoleRequest
UpdateRoleRequest
ClientConfigOutputData
RoleUpdatePermission
ClientConfigOutput
RoleUpdatePendingResponse
AssignPermissionsToRolesRequest
PartnerClientMappingOutputData
RemovePermissionsFromRolesRequest
PartnerClientMappingOutput
CreatePermissionRequest
PartnerClientMappingOutputArray
CreateBulkPermissionsRequest
UpdatePermissionRequest
PartnerOutputData
Product
PartnerOutput
UpdatePartnerInput
PartnerOutputArray
SetDefaultPartnerInput
partnerSetupData
CreateProductSubscriptionOutputData
ProductSubscriptionOutput
ProductSubscriptionOutputArray
CreateMultipleProfilesInput
ProfileOutputData
ProfileOutput
ProfileOutputArray
StatementOutput
UpdateSubClientInput
EntryOutput
SubClientOutputData
ApprovalRequestApprovalInput
ApprovalRequestOutput
ApprovalRequestOutputArray
DocumentOutput
DocumentOutputArray
SubClientOutput
SubClientOutputArray
SubClientDocUploadInput
SubClientRequiredDocsOutputData
SubClientRequiredDocsOutput
Schemas
Copy Page
LoginRequest
{
"email"
:
"john.doe@gmail.com"
,
"password"
:
"pasWTword@123"
}