Xtrempay Api Documentation
xtrempay
Billers
xtrempay
Xtrempay Api Guide
Authentication
biometric
Request Login Challenge
Login Using Biometrics
Register Biometric on Signup
Initiate Money Transfer wth Biometric Verification
Register User
Verify OTP & Issue Tokens
Refresh Token
Send Password Reset Code
Verify Password Reset Code
Set New Password
Verify Email Address
Password Login
Resend Email Verification Link
Register User (Email)
Verify OTP For Email & Issue Tokens
Resend OTP to Email
Onboarding
Verify BVN/NIN
Create User Profile
Initiate phone number verification
Resend OTP for phone number verification
Verify phone number OTP
Save & update user avatar
Set User Transaction Pin
Get User KYC Progress
Set User Password
Complete KYC Verification
User Account
Home Screen
Fetch Wallet Balance
Fetch Recent Transaction
Transaction
Lookup Account Holder
Generate a quote for any transaction type
Initiate Money Transfer
Fetch Transaction Receipt
Fetch Supported Banks
Cancel Transaction
List & Search Beneficiaries
Billers
List Billers by Service Type
List Products for a Biller
Initiate Bill Payment
Customer Validation
Profile&Settings
Fetch My Profile
Update My Profile
Fetch Account Transactions
Change user password
Fetch Account Transfer Limits
Upgrade limits (e.g. after KYC or plan change)
Generate Account Statement
Add a new card
Delete Card
Close User Account
Update User System Avatar
Savings
Trivial
Get Trivia Eligibility
Start a new trivia session
Get trivia questions for a session
Submit an answer to a trivia question
Get results of a trivia session
Get current active trivia challenge
Get leaderboard for a trivia challenge
Get current or last trivia challenge
Raffle
Fetch User’s Raffle Tickets By Month
Spin&Win
Spin the Wheel
Get Spin & Win Configuration
Get User Spin Coin
Fetch a Single Savings Balance
Fetch Recent Transactions by Savings Type
Add and fund a Savings Plan
Withdraw to Wallet
Fetch Saving plans
Top up a savings plan
Fetch Account Details
Get User Registration Status
Admin
Admin
Batch delete virtual accounts
Admin - Trivia Prize Tiers
Configure prize tiers for a challenge
Get prize tiers for a challenge
Admin - Coin Gifts
Award spin coins and retry tokens to a single user
Award spin coins and retry tokens to multiple users
Admin - Trivia Prize Management
Process winners for a trivia challenge
Credit prizes to winners' wallets
Process winners and credit prizes in one operation
Create a new trivia challenge
Update an existing trivia challenge
Syncing Default Banks for Kegow
Syncing All Billers details
Create a promotion
Backfill referral codes
Set agent referral flag
Webhook
sagecloud
Receive SageCloud webhook events
Webhook health check
Receive Kegow transfer webhook
Promotions
Get active promotions by placement
pushNotification
Push
Register or update a device push token
Send a direct test push (non-prod / internal)
Deactivate a device (logout / manual disable)
List devices for a user (debug/admin)
Referral
Get current user referral code
Get referred users
Schemas
DTOs
Authentication
UserRegistrationResponse
ResetPasswordRequest
VerifyOtpResponse
VerifyOtpRequest
RefreshTokenRequest
AuthResponse
RegisterUserRequest
ForgotPasswordRequest
VerifyResetCodeRequest
VerifyEmailResponse
VerifyResetCodeResponse
Onboarding
RegisterDeviceResponse
UserProfileRequest
SetPasswordRequest
SetPinRequest
UserProfileResponse
User Account
Home Screen
FetchWalletBalanceResponse
FetchRecentTransactionsResponse
FetchServicesResponse
FetchPromotionsResponse
Transaction
ListBeneficiariesResponse
ResolveAccountRequest
ResolveAccountResponse
TransferRequest
TransferResponse
ExecuteTransferRequest
InitiateTransferResponse
VerifyTransactionPinRequest
FetchTransactionReceiptResponse
FetchBanksResponse
Billers
ListBillerProductsResponse
InitiateBillPaymentResponse
FetchAirtimeProvidersResponse
FetchAirtimePlansResponse
ListBillersResponse
ValidateCustomerRequest
ValidateCustomerResponse:
InitiateBillPaymentRequest
Profile&Settings
GetMyProfileResponse
UpdateMyProfileRequest
AccountTransactionsResponse
FetchAccountLimitResponse
UpgradeLImitRequest
UpgradeLimitResponse
GenerateAccountStatementResponse
AddCardResponse
SavedAvatarResponse
Savings
FetchSavingBalanceResponse
FundSavingPlanRequest
FundSavingPlanResponse
WithdrawToWalletRequest
FetchRaffleTicketsResponse
GetSpinWinResponse
SpinTheWheelResponse
ProfileDetailsResponse
AuthStatusResponse
TriviaEligibilityResponse
GetSessionQuestionsResponse
CreateSessionResponse
SubmitAnswerResponse
TriviaResultResponse.java
CurrentTriviaResponse
GetLeaderboardResponse
Schemas
TransactionStatus
TransactionType
CloseAccountRequest
TransferWebhookPayload
PromotionCreateRequestJson
TransactionQuoteRequest
UpdateAvatarRequest
PromotionCreateRequestMultipart
DebugPushRequest
DeactivateDeviceRequest
PromotionResponse
DebugPushResult
BankTransferQuoteRequest
XApiResponseBase
UserDeviceResponse
BillPaymentQuoteRequest
XApiResponsePromotionResponse
RegisterDeviceRequest
TransactionQuoteResponse
XApiResponsePromotionResponseList
XApiError
XApiResponse
GenerateAccountStatementRequest
FetchSavingPlansResponse
TopUpSavingsPlanRequest
TopUpSavingsResponse
RequestLoginChallengeResponse
KycStatusResponse
SageCloudWebhookPayload
BatchDeleteVirtualAccountRequest
TriviaPrizeTierRequest
AwardCoinGiftRequest
XApiResponseChallengeDetailResponse
ReferralCodeResponse
SageCloudWebhookData
BatchDeleteVirtualAccountResponse
TriviaPrizeTierResponse
AwardCoinGiftResponse
XApiResponseString
ReferredUserResponse
WebhookResponse
DeleteResult
ApiResponse
BulkAwardCoinGiftRequest
ChallengeDetailResponse
ReferredUsersResponse
BulkAwardCoinGiftResponse
ReferralBackfillResponse
ReferralAgentToggleRequest
XApiResponseReferralCodeResponse
ErrorResponse
XApiResponseReferredUsersResponse
XApiResponseReferralBackfillResponse
Billers
FetchAirtimeProvidersResponse(FetchAirtimeProvidersResponse)
{
"code"
:
"string"
,
"name"
:
"string"
,
"icon"
:
"http://example.com"
}