Skip to main content
Danipa
Public docs · API

API reference.

Complete REST API reference for the Danipa Fintech Platform. Explore 675+ endpoints across 108 categories covering merchant APIs, payment links, invoices, analytics, remittance, wallets, KYC, and MTN MoMo integration.

Get API keysGetting started

Base URL

https://api.sandbox.danipa.com/ms

Sandbox · api.danipa.com at production launch

Authentication

Bearer JWT / Basic Auth

Spec Version

OpenAPI 3.1.0

· Tag

V4 Lodging — Settings

Phase 1.3.8 — cancellation policy + default check-in/out times per merchant + environment.

2 endpoints

MethodPath
GET/v1/merchants/me/lodging/settings
PUT/v1/merchants/me/lodging/settings
· Tag

Rental Leads

Merchant-facing inbox for public-catalog quote requests.

5 endpoints

MethodPath
POST/v1/merchants/me/rental-leads/{leadId}/dismiss
POST/v1/merchants/me/rental-leads/{leadId}/convert
GET/v1/merchants/me/rental-leads
GET/v1/merchants/me/rental-leads/{leadId}
GET/v1/merchants/me/rental-leads/unread-count
· Tag

Merchant Wallet

A merchant's own operating balance and ledger

2 endpoints

MethodPath
GET/v1/merchants/me/wallet/transactions/{currency}
GET/v1/merchants/me/wallet/balances
· Tag

Agent Profile

Current user's agent profile

1 endpoint

MethodPath
GET/v1/agents/me
· Tag

Billing & Pricing

Pricing plans, subscriptions, and billing usage

17 endpoints

MethodPath
POST/v1/merchants/me/subscription/upgrade
POST/v1/merchants/me/billing/portal
POST/v1/merchants/me/billing/modules/{moduleKey}/subscribe
DELETE/v1/merchants/me/billing/modules/{moduleKey}/subscribe
POST/v1/merchants/me/billing/modules/{moduleKey}/momo/finalize
POST/v1/merchants/me/billing/modules/content
DELETE/v1/merchants/me/billing/modules/content
POST/v1/merchants/me/billing/checkout
POST/v1/merchants/me/billing/bundles/{bundleKey}/subscribe
DELETE/v1/merchants/me/billing/bundles/{bundleKey}/subscribe
GET/v1/pricing-plans
GET/v1/pricing-plans/{name}
GET/v1/merchants/me/billing/usage
GET/v1/merchants/me/billing/plans
GET/v1/merchants/me/billing/payment-methods
GET/v1/merchants/me/billing/fee-preview
GET/v1/merchants/me/billing/bundles
· Tag

MFA

Multi-factor authentication — SMS OTP, TOTP, Passkeys

20 endpoints

MethodPath
POST/v1/mfa/totp/verify
POST/v1/mfa/totp/setup
POST/v1/mfa/totp/disable
POST/v1/mfa/totp/authenticate
POST/v1/mfa/step-up/validate
POST/v1/mfa/step-up/token
POST/v1/mfa/step-up/check
POST/v1/mfa/sms/verify
POST/v1/mfa/sms/send
POST/v1/mfa/sms/enable
POST/v1/mfa/sms/enable/verify
POST/v1/mfa/passkey/register/options
POST/v1/mfa/passkey/register/complete
POST/v1/mfa/passkey/authenticate/options
POST/v1/mfa/passkey/authenticate/complete
POST/v1/mfa/disable
GET/v1/mfa/settings
GET/v1/mfa/required
GET/v1/mfa/passkeys
DELETE/v1/mfa/passkeys/{id}
· Tag

Public Rentals

Customer-facing rental status (no auth).

1 endpoint

MethodPath
GET/v1/public/rentals/{shortCode}
· Tag

Rental Agreements

Rental MVP — quotes and bookings against rental assets.

7 endpoints

MethodPath
GET/v1/merchants/me/rentals/agreements
POST/v1/merchants/me/rentals/agreements
POST/v1/merchants/me/rentals/agreements/{agreementId}/return
POST/v1/merchants/me/rentals/agreements/{agreementId}/pickup
POST/v1/merchants/me/rentals/agreements/{agreementId}/payment-link
GET/v1/merchants/me/rentals/agreements/{agreementId}
GET/v1/merchants/me/rentals/agreements/{agreementId}/agreement.pdf
· Tag

Account Deletion (public)

Unauthenticated cancel endpoint for MFG-1 web cancel page

1 endpoint

MethodPath
POST/v1/account-deletion/cancel-via-token
· Tag

Rental Yards

§3.3 — physical locations where the merchant stocks rental inventory.

5 endpoints

MethodPath
GET/v1/merchants/me/rentals/yards/{yardId}
PUT/v1/merchants/me/rentals/yards/{yardId}
DELETE/v1/merchants/me/rentals/yards/{yardId}
GET/v1/merchants/me/rentals/yards
POST/v1/merchants/me/rentals/yards
· Tag

Rental Assets

Rental MVP — physical assets (generators, scaffolds, tools) available for rent.

10 endpoints

MethodPath
GET/v1/merchants/me/rentals/assets/{assetId}
PUT/v1/merchants/me/rentals/assets/{assetId}
DELETE/v1/merchants/me/rentals/assets/{assetId}
GET/v1/merchants/me/rentals/assets
POST/v1/merchants/me/rentals/assets
GET/v1/merchants/me/rentals/assets/{assetId}/inspections
POST/v1/merchants/me/rentals/assets/{assetId}/inspections
GET/v1/merchants/me/rentals/assets/{assetId}/utilization
GET/v1/merchants/me/rentals/assets/{assetId}/inspections/latest
GET/v1/merchants/me/rentals/assets/{assetId}/bookings
· Tag

Merchant Branding

Logo, brand color, and receipt header/footer for merchant-facing surfaces.

2 endpoints

MethodPath
GET/v1/merchants/me/branding
PUT/v1/merchants/me/branding
· Tag

Remittance - MTN Mobile Money (MoMo) API

Remit funds to local recipients from the diaspora with ease. This API allows you to send money to local recipients in various countries, facilitating cross-border transactions seamlessly.

13 endpoints

MethodPath
POST/v1/remittance/transfer
POST/v1/remittance/cash/transfer
POST/v1/remittance/auth/oauth2/token
POST/v1/remittance/auth/oauth/token
POST/v1/remittance/auth/authorize
POST/v1/remittance/account/{accountHolderMSISDN}/userinfo
POST/v1/remittance/account/consent/userinfo
POST/v1/remittance/account/999{accountHolderMSISDN}999/userinfo
GET/v1/remittance/transfer/{referenceId}/status
GET/v1/remittance/cash/transfer/{referenceId}/status
GET/v1/remittance/account/{currency}/balance
GET/v1/remittance/account/{accountHolderIdType}/{accountHolderId}/status
GET/v1/remittance/account/balance
· Tag

Savings

Savings goals — create, deposit, withdraw, track progress

8 endpoints

MethodPath
GET/v1/savings/goals
POST/v1/savings/goals
POST/v1/savings/goals/{id}/withdraw
POST/v1/savings/goals/{id}/deposit
GET/v1/savings/goals/{id}
DELETE/v1/savings/goals/{id}
GET/v1/savings/goals/{id}/transactions
GET/v1/savings/goals/{id}/progress
· Tag

V3 Spa — Appointments

Phase 1 — slot search + book an appointment.

2 endpoints

MethodPath
POST/v1/merchants/me/spa/appointments
GET/v1/merchants/me/spa/appointments/slots
· Tag

Accessibility

Accessibility preferences management

4 endpoints

MethodPath
GET/v1/accessibility/preferences
PUT/v1/accessibility/preferences
POST/v1/accessibility/preferences/reset
GET/v1/accessibility/color-blind-modes
· Tag

Public Spa Catalog

Public per-merchant spa / services catalog. No authentication; throttled by IP.

1 endpoint

MethodPath
GET/v1/public/merchants/{merchantSlug}/spa-catalog
· Tag

Business Payroll

Bulk payment processing for businesses

16 endpoints

MethodPath
PUT/v1/merchants/me/payroll/templates/{templateId}
DELETE/v1/merchants/me/payroll/templates/{templateId}
GET/v1/merchants/me/payroll
POST/v1/merchants/me/payroll
POST/v1/merchants/me/payroll/{batchId}/retry
POST/v1/merchants/me/payroll/{batchId}/process
POST/v1/merchants/me/payroll/upload
GET/v1/merchants/me/payroll/templates
POST/v1/merchants/me/payroll/templates
GET/v1/merchants/me/payroll/schedules
POST/v1/merchants/me/payroll/schedules
GET/v1/merchants/me/payroll/{batchId}
GET/v1/merchants/me/payroll/{batchId}/preview
GET/v1/merchants/me/payroll/{batchId}/failed
GET/v1/merchants/me/payroll/{batchId}/failed/export.csv
DELETE/v1/merchants/me/payroll/schedules/{scheduleId}
· Tag

V3 Spa — Memberships

BE-7 — membership-plan catalog + subscribe.

6 endpoints

MethodPath
GET/v1/merchants/me/spa/memberships/{id}
PUT/v1/merchants/me/spa/memberships/{id}
DELETE/v1/merchants/me/spa/memberships/{id}
GET/v1/merchants/me/spa/memberships
POST/v1/merchants/me/spa/memberships
POST/v1/merchants/me/spa/memberships/{id}/purchase
· Tag

Merchant Pay Domains

Merchant self-serve custom checkout domains (task #15). Attach → verify → set-primary lifecycle over merchant_pay_domain.

5 endpoints

MethodPath
GET/v1/merchants/me/pay-domains
POST/v1/merchants/me/pay-domains
POST/v1/merchants/me/pay-domains/{hostname}/verify
POST/v1/merchants/me/pay-domains/{hostname}/primary
DELETE/v1/merchants/me/pay-domains/{hostname}
· Tag

Public Fan Signup

Public per-merchant fan-list signup. No authentication; throttled by IP and hCaptcha-guarded.

1 endpoint

MethodPath
POST/v1/public/merchants/{merchantSlug}/fans
· Tag

Public Merchant Directory

Public opt-in merchant directory (slug, business name, city, storefront verticals) in one call. No authentication; throttled by IP.

1 endpoint

MethodPath
GET/v1/public/merchants/directory
· Tag

Disputes

File and track transaction disputes

5 endpoints

MethodPath
GET/v1/disputes
POST/v1/disputes
POST/v1/disputes/{disputeId}/escalate
POST/v1/disputes/{disputeId}/comments
GET/v1/disputes/{disputeId}
· Tag

Analytics

Merchant analytics and reporting

1 endpoint

MethodPath
GET/v1/merchants/me/analytics
· Tag

V2 Restaurant — Menu Items

PR1 — menu items (Sellable, kind=MENU_ITEM) + variants, modifier groups/options, and per-item availability (86 toggle / time windows).

20 endpoints

MethodPath
GET/v1/merchants/me/restaurant/menu/items/{itemId}
PUT/v1/merchants/me/restaurant/menu/items/{itemId}
DELETE/v1/merchants/me/restaurant/menu/items/{itemId}
PUT/v1/merchants/me/restaurant/menu/items/{itemId}/variants/{variantId}
DELETE/v1/merchants/me/restaurant/menu/items/{itemId}/variants/{variantId}
PUT/v1/merchants/me/restaurant/menu/items/{itemId}/modifier-groups/{groupId}
DELETE/v1/merchants/me/restaurant/menu/items/{itemId}/modifier-groups/{groupId}
PUT/v1/merchants/me/restaurant/menu/items/{itemId}/modifier-groups/{groupId}/modifiers/{modifierId}
DELETE/v1/merchants/me/restaurant/menu/items/{itemId}/modifier-groups/{groupId}/modifiers/{modifierId}
PUT/v1/merchants/me/restaurant/menu/items/{itemId}/availability/{availabilityId}
DELETE/v1/merchants/me/restaurant/menu/items/{itemId}/availability/{availabilityId}
GET/v1/merchants/me/restaurant/menu/items
POST/v1/merchants/me/restaurant/menu/items
GET/v1/merchants/me/restaurant/menu/items/{itemId}/variants
POST/v1/merchants/me/restaurant/menu/items/{itemId}/variants
GET/v1/merchants/me/restaurant/menu/items/{itemId}/modifier-groups
POST/v1/merchants/me/restaurant/menu/items/{itemId}/modifier-groups
POST/v1/merchants/me/restaurant/menu/items/{itemId}/modifier-groups/{groupId}/modifiers
GET/v1/merchants/me/restaurant/menu/items/{itemId}/availability
POST/v1/merchants/me/restaurant/menu/items/{itemId}/availability
· Tag

Rental Customer Rate Sheets

§2.6 — per-customer rate-card overrides for rental asset types. createQuote consults these before falling back to the type's default rates.

3 endpoints

MethodPath
GET/v1/merchants/me/customers/{customerId}/rate-sheets
POST/v1/merchants/me/customers/{customerId}/rate-sheets
DELETE/v1/merchants/me/customers/{customerId}/rate-sheets/{rateSheetId}
· Tag

Public Pharmacy Order

Public per-merchant OTC pharmacy order placement + status. No authentication; hCaptcha-guarded write, IP rate-limited, priced server-side from pharmacy-service.

2 endpoints

MethodPath
POST/v1/public/merchants/{merchantSlug}/pharmacy/orders
GET/v1/public/merchants/{merchantSlug}/pharmacy/orders/{shortCode}
· Tag

Payment Requests

Request money from other Danipa users

6 endpoints

MethodPath
POST/v1/payment-requests
POST/v1/payment-requests/{id}/reject
POST/v1/payment-requests/{id}/cancel
POST/v1/payment-requests/{id}/accept
GET/v1/payment-requests/sent
GET/v1/payment-requests/received
· Tag

Subscriptions

Recurring billing — auto-create invoices on a cadence (weekly/monthly/quarterly/yearly)

6 endpoints

MethodPath
GET/v1/merchants/me/subscriptions
POST/v1/merchants/me/subscriptions
POST/v1/merchants/me/subscriptions/{subscriptionId}/resume
POST/v1/merchants/me/subscriptions/{subscriptionId}/pause
POST/v1/merchants/me/subscriptions/{subscriptionId}/cancel
GET/v1/merchants/me/subscriptions/{subscriptionId}
· Tag

Public Payment Status

Read-only payment status by opaque public reference. No auth; throttled per IP.

1 endpoint

MethodPath
GET/v1/public/payments/{publicRef}/status
· Tag

Pay Domain Resolve

Public host → merchant resolve for merchant-branded checkout custom domains.

1 endpoint

MethodPath
GET/v1/public/pay/resolve-domain
· Tag

V3 Spa — Packages

BE-7 — prepaid package catalog + sale.

6 endpoints

MethodPath
GET/v1/merchants/me/spa/packages/{id}
PUT/v1/merchants/me/spa/packages/{id}
DELETE/v1/merchants/me/spa/packages/{id}
GET/v1/merchants/me/spa/packages
POST/v1/merchants/me/spa/packages
POST/v1/merchants/me/spa/packages/{id}/purchase
· Tag

Team

Team member and invitation management

10 endpoints

MethodPath
GET/v1/merchants/me/team/invites
POST/v1/merchants/me/team/invites
POST/v1/merchants/me/team/invites/{inviteId}/resend
POST/v1/merchants/me/team/invites/{inviteId}/extend
POST/v1/merchants/me/team/invites/decline
POST/v1/merchants/me/team/invites/accept
GET/v1/merchants/me/team/members
GET/v1/merchants/me/team/invites/received
DELETE/v1/merchants/me/team/members/{memberId}
DELETE/v1/merchants/me/team/invites/{inviteId}
· Tag

V3 Spa — Appointment operations

Phase 2 — list / detail + lifecycle (check-in, complete→invoice, cancel, no-show, reschedule).

7 endpoints

MethodPath
POST/v1/merchants/me/spa/appointments/manage/{orderId}/reschedule
POST/v1/merchants/me/spa/appointments/manage/{orderId}/no-show
POST/v1/merchants/me/spa/appointments/manage/{orderId}/complete
POST/v1/merchants/me/spa/appointments/manage/{orderId}/check-in
POST/v1/merchants/me/spa/appointments/manage/{orderId}/cancel
GET/v1/merchants/me/spa/appointments/manage
GET/v1/merchants/me/spa/appointments/manage/{orderId}
· Tag

V4 Lodging — Rooms

Phase 1.3.3 — physical bookable units belonging to a room_type.

5 endpoints

MethodPath
PUT/v1/merchants/me/lodging/rooms/{roomId}
DELETE/v1/merchants/me/lodging/rooms/{roomId}
GET/v1/merchants/me/lodging/rooms
POST/v1/merchants/me/lodging/rooms
POST/v1/merchants/me/lodging/rooms/bulk
· Tag

Merchant Refunds

Refund a merchant's own Stripe payments

2 endpoints

MethodPath
GET/v1/merchant/payments/{transactionId}/refunds
POST/v1/merchant/payments/{transactionId}/refunds
· Tag

Rental Booking Holds

§3.10 — short-lived reservations with TTL. Holds participate in collision detection alongside PAID/ACTIVE agreements; auto-expire past expiresAt.

5 endpoints

MethodPath
GET/v1/merchants/me/rentals/holds
POST/v1/merchants/me/rentals/holds
POST/v1/merchants/me/rentals/holds/{holdId}/convert
GET/v1/merchants/me/rentals/holds/{holdId}
DELETE/v1/merchants/me/rentals/holds/{holdId}
· Tag

FX Quotes

Create and retrieve locked FX quotes for send money flow

2 endpoints

MethodPath
POST/v1/fx/quotes
GET/v1/fx/quotes/{quoteId}
· Tag

Agent Territories

Manage agent operating territories

6 endpoints

MethodPath
PUT/v1/admin/agent-territories/{territoryId}/agents/{agentId}
GET/v1/admin/agent-territories/{id}
PUT/v1/admin/agent-territories/{id}
DELETE/v1/admin/agent-territories/{id}
GET/v1/admin/agent-territories
POST/v1/admin/agent-territories
· Tag

Merchant Capabilities

First-class capability flags (pharmacy / clinic) for the current merchant — see issue #1730.

1 endpoint

MethodPath
GET/v1/merchants/me/capabilities
· Tag

Statements

Merchant monthly statements

3 endpoints

MethodPath
GET/v1/merchants/me/statements/monthly
GET/v1/merchants/me/statements/monthly.pdf
GET/v1/merchants/me/statements/monthly.csv
· Tag

Public Config

Public configuration endpoints for client apps

5 endpoints

MethodPath
GET/v1/config/payout-methods/{countryCode}
GET/v1/config/features
GET/v1/config/currencies
GET/v1/config/countries
GET/v1/config/app
· Tag

Public Contract Sign

Anonymous e-signature by opaque sign token. No authentication; per-IP rate limited.

3 endpoints

MethodPath
POST/v1/public/contracts/{signToken}/sign
GET/v1/public/contracts/{signToken}
GET/v1/public/contracts/{signToken}/document.pdf
· Tag

Booking Earnings

Merchant earnings — per-currency roll-up of Danipa-processed + externally-recorded booking payments.

1 endpoint

MethodPath
GET/v1/merchants/me/earnings
· Tag

Public Fan Unsubscribe

Public tokenized unsubscribe from a fan list. No authentication; IP-throttled.

1 endpoint

MethodPath
POST/v1/public/merchants/{merchantSlug}/fans/unsubscribe
· Tag

Credit Score

Credit scoring — view score, history, factors, and eligibility

5 endpoints

MethodPath
POST/v1/credit/score/recalculate
GET/v1/credit/score
GET/v1/credit/score/history
GET/v1/credit/score/factors
GET/v1/credit/eligibility
· Tag

Rate Alerts

Currency rate alert management

3 endpoints

MethodPath
GET/v1/notifications/rate-alerts
POST/v1/notifications/rate-alerts
DELETE/v1/notifications/rate-alerts/{alertId}
· Tag

Booking Inquiries

Merchant CRM — list / detail + status machine + notes timeline for booking inquiries.

9 endpoints

MethodPath
POST/v1/merchants/me/inquiries/{orderId}/requote
POST/v1/merchants/me/inquiries/{orderId}/record-payment
POST/v1/merchants/me/inquiries/{orderId}/quote
POST/v1/merchants/me/inquiries/{orderId}/payments/{paymentId}/void
POST/v1/merchants/me/inquiries/{orderId}/notes
POST/v1/merchants/me/inquiries/{orderId}/balance-link
PATCH/v1/merchants/me/inquiries/{orderId}/status
GET/v1/merchants/me/inquiries
GET/v1/merchants/me/inquiries/{orderId}
· Tag

V3 Spa — Resources & Schedules

Phase 1 — bookable resources (staff/rooms) + recurring working hours + time-off.

10 endpoints

MethodPath
PUT/v1/merchants/me/spa/resources/{resourceId}
DELETE/v1/merchants/me/spa/resources/{resourceId}
GET/v1/merchants/me/spa/resources
POST/v1/merchants/me/spa/resources
GET/v1/merchants/me/spa/resources/{resourceId}/schedule/rules
POST/v1/merchants/me/spa/resources/{resourceId}/schedule/rules
GET/v1/merchants/me/spa/resources/{resourceId}/schedule/overrides
POST/v1/merchants/me/spa/resources/{resourceId}/schedule/overrides
DELETE/v1/merchants/me/spa/resources/{resourceId}/schedule/rules/{ruleId}
DELETE/v1/merchants/me/spa/resources/{resourceId}/schedule/overrides/{overrideId}
· Tag

Point of Sale

POS sales, catalog, staff, and reporting

15 endpoints

MethodPath
PUT/v1/pos/staff/{staffId}
DELETE/v1/pos/staff/{staffId}
PUT/v1/pos/catalog/{itemId}
DELETE/v1/pos/catalog/{itemId}
POST/v1/pos/transactions/{id}/confirm
GET/v1/pos/staff
POST/v1/pos/staff
POST/v1/pos/sale
POST/v1/pos/refund
GET/v1/pos/catalog
POST/v1/pos/catalog
GET/v1/pos/users/search
GET/v1/pos/transactions
GET/v1/pos/transactions/{txnId}
GET/v1/pos/reports/daily
· Tag

MoMo Pre-Approvals

MTN MoMo recurring-charge mandates: merchant-scoped create, list, sync, cancel

5 endpoints

MethodPath
GET/v1/merchants/me/momo/preapprovals
POST/v1/merchants/me/momo/preapprovals
POST/v1/merchants/me/momo/preapprovals/{ourReferenceId}/sync
POST/v1/merchants/me/momo/preapprovals/{ourReferenceId}/cancel
POST/v1/merchants/me/momo/preapprovals/sync-by-payer
· Tag

Localization

Language and locale management

9 endpoints

MethodPath
PUT/v1/localization/preferences/language
PUT/v1/admin/translations/{id}
DELETE/v1/admin/translations/{id}
POST/v1/admin/translations
GET/v1/localization/preferences
GET/v1/localization/messages/{language}
GET/v1/localization/messages/{language}/{category}
GET/v1/localization/languages
GET/v1/admin/translations/{key}
· Tag

Payment Methods

Manage saved payment methods for Stripe

8 endpoints

MethodPath
PUT/v1/payment-methods/default
POST/v1/payment-methods/sync
POST/v1/payment-methods/setup-intent
POST/v1/payment-methods/paypal
POST/v1/payment-methods/paypal/setup
POST/v1/payment-methods/paypal/confirm
GET/v1/payment-methods
DELETE/v1/payment-methods/{paymentMethodId}
· Tag

V4 Lodging — Room Rates

Phase 1.3.4 — seasonal rate overrides on room types.

4 endpoints

MethodPath
PUT/v1/merchants/me/lodging/room-rates/{rateId}
DELETE/v1/merchants/me/lodging/room-rates/{rateId}
GET/v1/merchants/me/lodging/room-rates
POST/v1/merchants/me/lodging/room-rates
· Tag

Disbursement - MTN Mobile Money (MoMo) API

APIs for initiating, authorizing, and managing MTN MoMo disbursement transactions to multiple recipients.

16 endpoints

MethodPath
PUT/v2/disbursement/deposit
POST/v2/disbursement/refund
POST/v1/disbursement/transfer
POST/v1/disbursement/refund
POST/v1/disbursement/refund/{referenceId}/status
POST/v1/disbursement/deposit
POST/v1/disbursement/deposit/{referenceId}/status
POST/v1/disbursement/auth/oauth2/token
POST/v1/disbursement/auth/oauth/token
POST/v1/disbursement/auth/authorize
POST/v1/disbursement/account/consent/userinfo
GET/v1/disbursement/transfer/{referenceId}/status
GET/v1/disbursement/account/{currency}/balance
GET/v1/disbursement/account/{accountHolderIdType}/{accountHolderId}/userinfo
GET/v1/disbursement/account/{accountHolderIdType}/{accountHolderId}/status
GET/v1/disbursement/account/balance
· Tag

Fan Segments

Targetable audiences over the owned fan list (Danipa Stage)

6 endpoints

MethodPath
PUT/v1/merchants/me/segments/{segmentId}/members/{fanId}
DELETE/v1/merchants/me/segments/{segmentId}/members/{fanId}
GET/v1/merchants/me/segments
POST/v1/merchants/me/segments
GET/v1/merchants/me/segments/{segmentId}
GET/v1/merchants/me/segments/{segmentId}/members
· Tag

Receipts & Statements

Download transaction receipts and generate account statements

4 endpoints

MethodPath
GET/v1/statements
POST/v1/statements
GET/v1/statements/{statementId}
GET/v1/receipts/{transactionId}
· Tag

Ownership

Co-ownership operations (promote, step-down, transfer-primary, list owners)

4 endpoints

MethodPath
POST/v1/merchants/me/team/members/{userId}/step-down
POST/v1/merchants/me/team/members/{userId}/promote
POST/v1/merchants/me/owners/primary
GET/v1/merchants/me/owners
· Tag

Customers

Saved customer directory: contacts attached to invoices and payment links

7 endpoints

MethodPath
GET/v1/merchants/me/customers/{customerId}
PUT/v1/merchants/me/customers/{customerId}
DELETE/v1/merchants/me/customers/{customerId}
GET/v1/merchants/me/customers
POST/v1/merchants/me/customers
GET/v1/merchants/me/customers/insights
GET/v1/merchants/me/customers/by-phone
· Tag

Merchant Verticals

Per-merchant per-environment per-kind enabling toggle. See SELLABLE_ORDER_DESIGN_SPIKE_2026_05_12 §3.5.5.

2 endpoints

MethodPath
PUT/v1/merchants/me/verticals/{kind}
GET/v1/merchants/me/verticals
· Tag

Public Rental Catalog

Public per-merchant catalog page. No authentication; throttled by IP.

1 endpoint

MethodPath
GET/v1/public/merchants/{merchantSlug}/rental-catalog
· Tag

Recipients

Manage saved transfer recipients

4 endpoints

MethodPath
GET/v1/recipients
POST/v1/recipients
DELETE/v1/recipients/{id}
PATCH/v1/recipients/{id}
· Tag

Agent Operations

Agent banking operations: cash-in, cash-out, registration

11 endpoints

MethodPath
POST/v1/agents/{agentId}/register-customer
POST/v1/agents/{agentId}/float/topup
POST/v1/agents/{agentId}/cash-out
POST/v1/agents/{agentId}/cash-in
GET/v1/agents/{agentId}/transactions
GET/v1/agents/{agentId}/performance
GET/v1/agents/{agentId}/float/history
GET/v1/agents/{agentId}/float/balance
GET/v1/agents/{agentId}/dashboard
GET/v1/agents/{agentId}/commissions
GET/v1/agents/{agentId}/commissions/breakdown
· Tag

Public Merchant Slug List

Public list of merchant slugs with public catalogs enabled. Sitemap source. No authentication; throttled by IP.

1 endpoint

MethodPath
GET/v1/public/merchants/slugs
· Tag

Merchants

Merchant onboarding, API key management, and KYB verification

29 endpoints

MethodPath
PUT/v1/merchants/me/profile
GET/v1/merchants/me/oauth-apps/{appId}
PUT/v1/merchants/me/oauth-apps/{appId}
DELETE/v1/merchants/me/oauth-apps/{appId}
POST/v1/merchants
GET/v1/merchants/me/verification
POST/v1/merchants/me/verification
POST/v1/merchants/me/tos/accept
POST/v1/merchants/me/reopen
GET/v1/merchants/me/oauth-apps
POST/v1/merchants/me/oauth-apps
POST/v1/merchants/me/oauth-apps/{appId}/rotate-secret
POST/v1/merchants/me/notifications/{id}/read
POST/v1/merchants/me/notifications/read-all
POST/v1/merchants/me/close
GET/v1/merchants/me/api-keys
POST/v1/merchants/me/api-keys
POST/v1/merchants/me/api-keys/{keyId}/rotate
DELETE/v1/merchants/me/api-keys/{keyId}
PATCH/v1/merchants/me/api-keys/{keyId}
GET/v1/merchants/verification/{docId}/view-url
GET/v1/merchants/mine
GET/v1/merchants/me
GET/v1/merchants/me/usage
GET/v1/merchants/me/notifications
GET/v1/merchants/me/notifications/unread-count
GET/v1/merchants/me/logs
GET/v1/merchants/me/logs/{correlationId}
GET/v1/merchants/me/audit
· Tag

Public Merchant Header

Public merchant brand + About/Contact header by slug. No authentication; throttled by IP.

1 endpoint

MethodPath
GET/v1/public/merchants/{merchantSlug}/header
· Tag

Authentication

User registration and authentication

3 endpoints

MethodPath
POST/v1/auth/resend-verification
POST/v1/auth/register
POST/v1/auth/forgot-password
· Tag

Collection - MTN Mobile Money (MoMo) API

Provides endpoints to initiate, authorize, and manage remote collection of payments, bills, fees, or taxes using MTN Mobile Money (MoMo), enabling secure and automated financial transactions between service providers and account holders.

23 endpoints

MethodPath
PUT/v2/collection/payment/withdraw
POST/v1/collection/preapproval
POST/v1/collection/payment
POST/v1/collection/payment/{referenceId}/notification
POST/v1/collection/payment/withdraw
POST/v1/collection/payment/request
POST/v1/collection/invoice
POST/v1/collection/auth/oauth2/token
POST/v1/collection/auth/oauth/token
POST/v1/collection/auth/authorize
GET/v1/collection/preapproval/{referenceId}/status
GET/v1/collection/payment/{X-Reference-Id}/status
GET/v1/collection/payment/withdraw/{referenceId}/status
GET/v1/collection/payment/request/{referenceId}/status
GET/v1/collection/invoice/{X-Reference-Id}/status
GET/v1/collection/account/{currency}/balance
GET/v1/collection/account/{accountHolderIdType}/{accountHolderId}/userinfo
GET/v1/collection/account/{accountHolderIdType}/{accountHolderId}/status
GET/v1/collection/account/{accountHolderIdType}/{accountHolderId}/preapprovals
GET/v1/collection/account/consent/userinfo
GET/v1/collection/account/balance
DELETE/v1/collection/preapproval/{preApprovalId}/cancel
DELETE/v1/collection/invoice/{referenceId}/cancel
· Tag

Marketplace Connectors

OAuth install/callback for Shopify/WooCommerce/QBO/Xero connectors

4 endpoints

MethodPath
POST/v1/connectors/{provider}/install
POST/v1/connectors/me/{id}/disconnect
GET/v1/connectors/{provider}/callback
GET/v1/connectors/me
· Tag

Booking Inquiry Contracts

Merchant — generate/preview a contract, send for signature, track status, download PDFs.

6 endpoints

MethodPath
GET/v1/merchants/me/inquiries/{orderId}/contract
POST/v1/merchants/me/inquiries/{orderId}/contract
POST/v1/merchants/me/inquiries/{orderId}/contract/void
GET/v1/merchants/me/inquiries/{orderId}/contract/signed.pdf
GET/v1/merchants/me/inquiries/{orderId}/contract/preview
GET/v1/merchants/me/inquiries/{orderId}/contract/document.pdf
· Tag

Merchant Vertical Requests

Request an admin-gated vertical (pharmacy/clinic) → admin-approval queue. ADR-0025.

3 endpoints

MethodPath
GET/v1/merchants/me/vertical-requests
POST/v1/merchants/me/vertical-requests
DELETE/v1/merchants/me/vertical-requests/{id}
· Tag

Public Rental Quote Request

Public per-merchant quote-request submission. No authentication; throttled by IP + hCaptcha-guarded.

1 endpoint

MethodPath
POST/v1/public/merchants/{merchantSlug}/rental-quote-requests
· Tag

Document Storage

Signed URL generation for KYC/KYB document uploads

1 endpoint

MethodPath
POST/v1/storage/upload-url
· Tag

Bill Payments

Airtime, data bundles, utilities, and scheduled bill payments

11 endpoints

MethodPath
PUT/v1/bills/saved/{billerId}
DELETE/v1/bills/saved/{billerId}
GET/v1/bills/scheduled
POST/v1/bills/scheduled
GET/v1/bills/saved
POST/v1/bills/saved
POST/v1/bills/pay
GET/v1/bills/providers
GET/v1/bills/history
GET/v1/bills/history/{paymentId}
DELETE/v1/bills/scheduled/{scheduleId}
· Tag

V2 Restaurant — Orders

PR2 — place menu orders (item + variant + modifiers), tax/tip, and the PLACED→ACCEPTED→IN_PREP→READY→COMPLETED prep-status machine.

4 endpoints

MethodPath
GET/v1/merchants/me/restaurant/orders
POST/v1/merchants/me/restaurant/orders
POST/v1/merchants/me/restaurant/orders/{orderId}/transitions
GET/v1/merchants/me/restaurant/orders/{orderId}
· Tag

Engagement Calendar

Merchant calendar — schedule / release a booking inquiry's engagement date and read the calendar.

3 endpoints

MethodPath
POST/v1/merchants/me/inquiries/{orderId}/schedule
DELETE/v1/merchants/me/inquiries/{orderId}/schedule
GET/v1/merchants/me/calendar
· Tag

Payouts

Merchant payout estimates, history, destinations, and schedule

10 endpoints

MethodPath
GET/v1/merchants/me/payout-schedule
PUT/v1/merchants/me/payout-schedule
PUT/v1/merchants/me/payout-accounts/{id}
DELETE/v1/merchants/me/payout-accounts/{id}
POST/v1/merchants/me/payouts/execute
GET/v1/merchants/me/payout-accounts
POST/v1/merchants/me/payout-accounts
POST/v1/merchants/me/payout-accounts/{id}/make-default
GET/v1/merchants/me/payouts
GET/v1/merchants/me/payouts/estimate
· Tag

Merchant Payments

List a merchant's payment transactions

1 endpoint

MethodPath
GET/v1/merchant/payments
· Tag

Invoices

Create, manage, and send invoices with auto-generated payment links

10 endpoints

MethodPath
GET/v1/merchants/me/invoices/{invoiceId}
PUT/v1/merchants/me/invoices/{invoiceId}
GET/v1/merchants/me/invoices
POST/v1/merchants/me/invoices
POST/v1/merchants/me/invoices/{invoiceId}/void
POST/v1/merchants/me/invoices/{invoiceId}/send
POST/v1/merchants/me/invoices/{invoiceId}/record-payment
POST/v1/merchants/me/invoices/bulk
GET/v1/merchants/me/invoices/{invoiceId}/pdf
GET/v1/merchants/me/invoices/stats
· Tag

Commission Tiers

Manage volume-based commission rate tiers

5 endpoints

MethodPath
GET/v1/admin/commission-tiers/{id}
PUT/v1/admin/commission-tiers/{id}
DELETE/v1/admin/commission-tiers/{id}
GET/v1/admin/commission-tiers
POST/v1/admin/commission-tiers
· Tag

Public Lodging Catalog

Public per-merchant lodging catalog. No authentication; throttled by IP.

1 endpoint

MethodPath
GET/v1/public/merchants/{merchantSlug}/lodging-catalog
· Tag

Webhooks

Register and manage merchant webhook endpoints and view delivery history

9 endpoints

MethodPath
PUT/v1/merchants/me/webhooks/{endpointId}
DELETE/v1/merchants/me/webhooks/{endpointId}
GET/v1/merchants/me/webhooks
POST/v1/merchants/me/webhooks
POST/v1/merchants/me/webhooks/{endpointId}/test
POST/v1/merchants/me/webhooks/{endpointId}/rotate-secret
POST/v1/merchants/me/webhooks/{endpointId}/deliveries/{deliveryId}/replay
GET/v1/merchants/me/webhooks/{endpointId}/secret
GET/v1/merchants/me/webhooks/{endpointId}/deliveries
· Tag

Wallet

Digital wallet — creation, balances, currency accounts

16 endpoints

MethodPath
POST/v1/wallets
POST/v1/wallets/me/transfer
POST/v1/wallets/me/stripe-onboarding-link
POST/v1/wallets/me/refund
POST/v1/wallets/me/fund-in
POST/v1/wallets/me/fund-in/{fundInId}/confirm
POST/v1/wallets/me/cash-out
POST/v1/wallets/me/accounts/{currency}
DELETE/v1/wallets/me/accounts/{currency}
GET/v1/wallets/me
GET/v1/wallets/me/transactions/{currency}
GET/v1/wallets/me/stripe-onboarding-status
GET/v1/wallets/me/fund-ins
GET/v1/wallets/me/cash-outs
GET/v1/wallets/me/balances
GET/v1/wallets/me/balances/{currency}
· Tag

Public Lodging Booking

Public per-merchant lodging booking submission. No authentication; throttled by IP and hCaptcha-guarded.

1 endpoint

MethodPath
POST/v1/public/merchants/{merchantSlug}/lodging-bookings
· Tag

Transfers

Create and track money transfers

4 endpoints

MethodPath
GET/v1/transactions
POST/v1/transactions
GET/v1/transactions/{id}
GET/v1/transactions/corridors
· Tag

Fan Directory

The merchant's owned fan list: list, add, import, tag (Danipa Stage)

7 endpoints

MethodPath
PUT/v1/merchants/me/fans/{fanId}/tags/{tag}
DELETE/v1/merchants/me/fans/{fanId}/tags/{tag}
GET/v1/merchants/me/fans
POST/v1/merchants/me/fans
POST/v1/merchants/me/fans/import
GET/v1/merchants/me/fans/{fanId}
GET/v1/merchants/me/fan-tags
· Tag

Marketplace Connectors

Merchant-dashboard CRUD for installed connectors

4 endpoints

MethodPath
POST/v1/connectors/{provider}/install
POST/v1/connectors/me/{id}/disconnect
GET/v1/connectors/{provider}/callback
GET/v1/connectors/me
· Tag

Loans

Micro-loans — products, application, repayment, schedule

6 endpoints

MethodPath
POST/v1/loans/{id}/repay
POST/v1/loans/apply
GET/v1/loans
GET/v1/loans/{id}
GET/v1/loans/{id}/schedule
GET/v1/loans/products
· Tag

Merchant Stripe Connect

Connect a merchant's own Stripe account (Express acquiring)

2 endpoints

MethodPath
POST/v1/merchant/stripe-connect/onboarding-link
GET/v1/merchant/stripe-connect/status
· Tag

V3 Spa — Service Catalog

Phase 1 — bookable services + resource qualifications.

8 endpoints

MethodPath
GET/v1/merchants/me/spa/services/{id}
PUT/v1/merchants/me/spa/services/{id}
DELETE/v1/merchants/me/spa/services/{id}
GET/v1/merchants/me/spa/services
POST/v1/merchants/me/spa/services
GET/v1/merchants/me/spa/services/{id}/qualifications
POST/v1/merchants/me/spa/services/{id}/qualifications
DELETE/v1/merchants/me/spa/services/{id}/qualifications/{resourceId}
· Tag

Savings Plans

Auto-debit savings plans — recurring deposits, round-up savings

8 endpoints

MethodPath
PUT/v1/savings/plans/{id}
DELETE/v1/savings/plans/{id}
PUT/v1/savings/plans/{id}/round-up
GET/v1/savings/plans
POST/v1/savings/plans
POST/v1/savings/plans/{id}/resume
POST/v1/savings/plans/{id}/pause
GET/v1/savings/plans/{id}/history
· Tag

Public Spa Booking

Public per-merchant spa appointment submission. No authentication; throttled by IP and hCaptcha-guarded.

1 endpoint

MethodPath
POST/v1/public/merchants/{merchantSlug}/spa-bookings
· Tag

Fan Broadcasts

Compose + send broadcasts to fan segments (Danipa Stage)

4 endpoints

MethodPath
GET/v1/merchants/me/broadcasts
POST/v1/merchants/me/broadcasts
POST/v1/merchants/me/broadcasts/{broadcastId}/send
GET/v1/merchants/me/broadcasts/{broadcastId}
· Tag

V4 Lodging — Reservation operations

Phase 1.5.1 — merchant-facing reservation lifecycle (check-in, check-out, balance link, cancel, refund).

10 endpoints

MethodPath
POST/v1/merchants/me/lodging/reservations/{reservationId}/refund
POST/v1/merchants/me/lodging/reservations/{reservationId}/check-out
POST/v1/merchants/me/lodging/reservations/{reservationId}/check-in
POST/v1/merchants/me/lodging/reservations/{reservationId}/cancel
POST/v1/merchants/me/lodging/reservations/{reservationId}/balance-link
GET/v1/merchants/me/lodging/reservations
GET/v1/merchants/me/lodging/reservations/{reservationId}
GET/v1/merchants/me/lodging/reservations/{reservationId}/confirmation.pdf
GET/v1/merchants/me/lodging/reservations/today
GET/v1/merchants/me/lodging/reservations/calendar
· Tag

V2 Restaurant — Menu Categories

PR1 — merchant's reorderable menu sections (Starters, Mains, Drinks).

4 endpoints

MethodPath
PUT/v1/merchants/me/restaurant/menu/categories/{categoryId}
DELETE/v1/merchants/me/restaurant/menu/categories/{categoryId}
GET/v1/merchants/me/restaurant/menu/categories
POST/v1/merchants/me/restaurant/menu/categories
· Tag

Referrals

Referral program — invite friends, earn rewards

4 endpoints

MethodPath
POST/v1/referrals/signup
GET/v1/referrals
GET/v1/referrals/rewards
GET/v1/referrals/code
· Tag

Rental Asset Types

§2.5 — Catalog aggregates for kit-based inventory (e.g. 'Scaffold End Frame, qty 200'). Quotes resolve against types with a kit quantity; per-unit RentalAsset rows link back to a type.

6 endpoints

MethodPath
GET/v1/merchants/me/rentals/asset-types/{typeId}
PUT/v1/merchants/me/rentals/asset-types/{typeId}
DELETE/v1/merchants/me/rentals/asset-types/{typeId}
GET/v1/merchants/me/rentals/asset-types
POST/v1/merchants/me/rentals/asset-types
GET/v1/merchants/me/rentals/asset-types/{typeId}/availability
· Tag

V3 Spa — Customer entitlements

BE-7 — a customer's package balances + memberships.

1 endpoint

MethodPath
GET/v1/merchants/me/spa/customers/{customerId}/entitlements
· Tag

Public Booking Inquiry

Public per-merchant booking-inquiry submission. No authentication; throttled by IP and hCaptcha-guarded.

1 endpoint

MethodPath
POST/v1/public/merchants/{merchantSlug}/booking-inquiries
· Tag

Public Reservation Status

Read-only snapshot of a reservation by shortCode. No auth; throttled per IP.

2 endpoints

MethodPath
GET/v1/public/reservations/{shortCode}
GET/v1/public/reservations/{shortCode}/confirmation.pdf
· Tag

User Provisioning - MTN Mobile Money (MoMo) API

Endpoints for creating and managing sandbox API users and API keys for MTN MoMo integration testing. Sandbox-only by profile gate (dev / sandbox / test) — the bean is not instantiated in prod, so all routes return 404.

3 endpoints

MethodPath
POST/v1/user
POST/v1/user/{X-Reference-Id}/apikey
GET/v1/user/{X-Reference-Id}
· Tag

Exchange Rates

FX rates and fee calculations for send money flow

1 endpoint

MethodPath
GET/v1/exchange-rates
· Tag

Float Pools

Manage float pools and bulk allocation

6 endpoints

MethodPath
GET/v1/admin/float-pools/{id}
PUT/v1/admin/float-pools/{id}
DELETE/v1/admin/float-pools/{id}
GET/v1/admin/float-pools
POST/v1/admin/float-pools
POST/v1/admin/float-pools/{id}/allocate
· Tag

Agent Registration

Self-service agent application and KYB document upload

4 endpoints

MethodPath
PUT/v1/agent-applications/{id}/agreement
POST/v1/agent-applications
POST/v1/agent-applications/{id}/documents
GET/v1/agent-applications/mine
· Tag

Public Spa Slots

Public per-merchant bookable slot search. No authentication; throttled by IP.

1 endpoint

MethodPath
GET/v1/public/merchants/{merchantSlug}/spa-slots
· Tag

User Profile

Manage the authenticated user's profile

6 endpoints

MethodPath
PUT/v1/users/me/active-merchant
POST/v1/users/me/logout-all
POST/v1/users/me/account-deletion
POST/v1/users/me/account-deletion/cancel
GET/v1/users/me
PATCH/v1/users/me
· Tag

V4 Lodging — Room Types

Phase 1.3.2 — merchant catalog of room classes (Standard Double, Suite, etc). One RoomType = one Sellable.

5 endpoints

MethodPath
GET/v1/merchants/me/lodging/room-types/{typeId}
PUT/v1/merchants/me/lodging/room-types/{typeId}
DELETE/v1/merchants/me/lodging/room-types/{typeId}
GET/v1/merchants/me/lodging/room-types
POST/v1/merchants/me/lodging/room-types
· Auth

Authentication

The Danipa API supports two authentication schemes depending on the endpoint.

· Scheme 01

Bearer JWT.

Most API endpoints require a JWT Bearer token. Obtain a token by calling the authentication endpoint with your credentials. Include it in the Authorization header.

Authorization: Bearer eyJhbGciOi...
· Scheme 02

Basic Auth.

Token-creation endpoints (e.g., MTN MoMo OAuth) use HTTP Basic authentication. Provide your API User ID as the username and your API Key as the password, Base64-encoded.

Authorization: Basic base64(userId:apiKey)
· Schemas

Schemas

327 data models defined in the OpenAPI specification. Download the full spec for complete schema definitions including properties, types, and validation rules.

View all 327 models
AcceptInviteRequestAcceptTosRequestAccountBalanceAccountDeletionRequestBodyAccountPreApprovalsActiveMerchantRequestAddBankRequestAddCommentRequestAddFanRequestAddInquiryNoteRequestAddStaffRequestAdminCommentRequestAdvancePrepStatusRequestAgentApplicationRequestAgentApplicationResponseAgentApplicationReviewRequestAlertmanagerAlertAlertmanagerWebhookPayloadApiKeyResponseApiStatusApiUserApiUserKeyAppointmentCancelRequestAppointmentRescheduleRequestApproveVerticalRequestBodyAssignRequestAttachPayDomainRequestBasicUserInfoBcAuthorizeBcAuthorizeFormBillingCheckoutRequestBroadcastDetailBulkAllocateRequestBulkInvoiceImportRequestCancelByTokenRequestCancelInvoiceCashTransactionCashTransactionRequestConfirmQrPaymentRequestConsumerPremiumSubscribeRequestCreateAgentRequestCreateApiKeyRequestCreateApiUserCreateBatchRequestCreateBroadcastRequestCreateCatalogItemRequestCreateCountryProviderRequestCreateCountryRequestCreateDisputeRequestCreateInviteRequestCreateInvoiceRequestCreateMerchantRequestCreateMfiPartnerRequestCreatePaymentLinkRequestCreatePaymentRequestDTOCreatePoolRequestCreateRateAlertRequestCreateRecipientRequestCreateRequestCreateRoutingRuleRequestCreateRuleRequestCreateSavedBillerRequestCreateSavingsGoalRequestCreateSavingsPlanRequestCreateScheduleRequestCreateSegmentRequestCreateStatementRequestCreateSubscriptionRequestCreateTemplateRequestCreateTerritoryRequestCreateThresholdRequestCreateTierRequestCreateTranslationRequestCreateVerticalRequestBodyCreateWebhookEndpointRequestCsvUploadRequestCustomerRequestCustomerResponseDeliveryNotificationDepositStatusDnsChallengeRecordEnableSmsRequestEntryErrorReasonEscalateRequestExecuteRequestFanSummaryFieldErrorFloatTopUpRequestForgotPasswordRequestFreezeRequestFundInRequestFundInResponseFundOutRequestFundOutResponseFxQuoteRequestGenerateContractRequestHealthOrderCreateRequestInstallRequestInvoiceInvoiceResponseInvoiceStatusJsonNodeKybDocumentResponseKybDocumentUploadRequestKybReviewRequestKybSubmissionRequestKycReviewRequestLineLineItemLineItemRequestLinkPayPalRequestLinkRequestLoanApplicationRequestLoanRepaymentRequestLoanRepaymentResponseLoanResponseLodgingSettingsRequestLoginEventRequestMandateResponseMarkLeadConvertedRequestMarkLeadDismissedRequestMarkPickedUpRequestMarkReturnedRequestMembershipPurchaseRequestMenuCategoryCreateRequestMenuCategoryUpdateRequestMenuItemAvailabilityRequestMenuItemCreateRequestMenuItemUpdateRequestMenuItemVariantRequestMerchantCustomerRateSheetResponseMerchantCustomerRateSheetUpsertRequestMerchantMandateCreateRequestMerchantResponseMerchantVerticalUpdateRequestMfaSettingsResponseMfiPartnerResponseMfiPoolDepositRequestModifierGroupRequestModifierRequestModuleSubscribeRequestModuleSubscribeResponseMoneyOAuth2TokenOAuthAppSecretResponseOAuthTokenOauth2FormOtpSentResponseOtpVerifyResponseP2pTransferRequestP2pTransferResponsePackagePurchaseRequestPagePublicRentalAssetTypeResponsePagePublicRoomTypeResponsePagePublicSpaServiceResponsePageablePageableObjectPartyPasskeyAuthenticationRequestPasskeyRegistrationRequestPayBillRequestPayDomainDetailViewPayPalConfirmRequestPayPalSetupRequestPaymentPaymentLinkCheckoutRequestPaymentLinkCheckoutResponsePaymentLinkResponsePaymentRequestResponsePaymentStatusPharmacyOrderResponsePlaceMenuOrderRequestPlacePharmacyOrderRequestPreApprovalPreApprovalStatusPublicBookingInquiryPayloadPublicBookingInquiryResponsePublicContractViewPublicFanSignupPayloadPublicFanSignupResponsePublicFanUnsubscribeRequestPublicFanUnsubscribeResponsePublicLodgingBookingPayloadPublicLodgingBookingResponsePublicMerchantCatalogResponsePublicRentalAssetTypeResponsePublicMerchantCatalogResponsePublicRoomTypeResponsePublicMerchantCatalogResponsePublicSpaServiceResponsePublicMerchantDirectoryResponsePublicMerchantHeaderPublicMerchantSlugListResponsePublicPaymentStatusResponsePublicPharmacyOrderStatusResponsePublicPlaceMenuOrderRequestPublicRentalAssetTypeResponsePublicRentalQuoteRequestPayloadPublicReservationStatusResponsePublicRoomTypeResponsePublicSignRequestPublicSignResponsePublicSpaBookingPayloadPublicSpaBookingResponsePublicSpaServiceResponsePublicSpaSlotsResponseQualificationRequestQuoteLineQuoteRequestRecipientDtoRecipientResponseRecordPaymentRequestRecordSignupRequestRefundRequestRefundResponseRefundTransactionRefundTransactionStatusRegisterCustomerRequestRegisterOAuthAppRequestRegistrationRequestRejectVerticalRequestBodyRentalAgreementResponseRentalAssetCreateRequestRentalAssetInspectionCreateRequestRentalAssetInspectionResponseRentalAssetResponseRentalAssetTypeCreateRequestRentalAssetTypeResponseRentalAssetTypeUpdateRequestRentalAssetUpdateRequestRentalBookingHoldCreateRequestRentalBookingHoldResponseRentalLineItemResponseRentalQuoteCreateRequestRentalYardUpsertRequestResendVerificationRequestReservationCancelRequestReservationRefundRequestResolveRequestResourceCreateRequestResourceUpdateRequestReversalRequestReviewRequestRoomBulkCreateRequestRoomCreateRequestRoomRateCreateRequestRoomRateUpdateRequestRoomTypeCreateRequestRoomTypeUpdateRequestRoomUpdateRequestSaleRequestSandboxCreateTestCustomerResponseSandboxFundWalletRequestSandboxFundWalletResponseSandboxResetResponseSandboxTriggerWebhookRequestSandboxTriggerWebhookResponseSavingsDepositRequestSavingsDepositResponseSavingsGoalResponseSavingsPlanResponseSavingsWithdrawRequestSavingsWithdrawResponseScheduleEngagementRequestScheduleOverrideRequestScheduleRuleRequestSegmentDetailSendRentalPaymentLinkRequestSendRentalPaymentLinkResponseSetDefaultPaymentMethodRequestSetupIntentResponseSeveritySortObjectSpaBookingRequestSpaMembershipPlanCreateRequestSpaMembershipPlanUpdateRequestSpaPackageCreateRequestSpaPackageUpdateRequestSpaServiceCreateRequestSpaServiceUpdateRequestStatusInfoStepUpCheckRequestStepUpTokenRequestSubscriptionResponseSuspendRequestTaxLineResponseTestWebhookRequestToggleActiveRequestToggleBankRequestTransactionTransactionStatusTransferEventDtoTransferPrimaryRequestTransferRequestTransferResponseUpdateAgentRequestUpdateApiKeyRequestUpdateCatalogItemRequestUpdateCountryProviderRequestUpdateCountryRequestUpdateInquiryStatusRequestUpdateLanguageRequestUpdateMerchantBrandingRequestUpdateMerchantProfileRequestUpdateOAuthAppRequestUpdatePaymentLinkRequestUpdatePoolRequestUpdatePreferencesRequestUpdateProfileRequestUpdateRecipientRequestUpdateRequestUpdateRoundUpRequestUpdateRoutingRuleRequestUpdateRuleRequestUpdateSavedBillerRequestUpdateSavingsPlanRequestUpdateStaffRequestUpdateStatusRequestUpdateTemplateRequestUpdateTerritoryRequestUpdateThresholdRequestUpdateTierRequestUpdateTranslationRequestUploadUrlRequestUpsertRequestUserInfoValidateTokenRequestVerifyOtpRequestWebhookEndpointResponse
· Full OpenAPI specification

Download the spec.

Use the complete OpenAPI 3.1.0 spec with Swagger UI, Postman, or code generators.

MTN MoMo docs