Skip to main content
Danipa
OpenAPI 3.1.0v1.0

API Reference

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

Get API KeysGetting Started

Base URL

https://api.danipa.com/ms

Authentication

Bearer JWT / Basic Auth

Spec Version

OpenAPI 3.1.0

Invoices

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

5 endpoints

MethodPath
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

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

Wallet

Digital wallet — creation, balances, currency accounts

13 endpoints

MethodPath
POST/v1/wallets
POST/v1/wallets/me/transfer
POST/v1/wallets/me/refund
POST/v1/wallets/me/fund-in
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/fund-ins
GET/v1/wallets/me/cash-outs
GET/v1/wallets/me/balances
GET/v1/wallets/me/balances/{currency}

Transfers

Create and track money transfers

3 endpoints

MethodPath
GET/v1/transactions
POST/v1/transactions
GET/v1/transactions/{id}

Recipients

Manage saved transfer recipients

4 endpoints

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

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

KYC

Know Your Customer — document upload, status, and tier upgrade

4 endpoints

MethodPath
POST/v1/kyc/upgrade
POST/v1/kyc/documents
GET/v1/kyc/tiers
GET/v1/kyc/status

Merchants

Merchant onboarding, API key management, and KYB verification

8 endpoints

MethodPath
POST/v1/merchants
GET/v1/merchants/me/verification
POST/v1/merchants/me/verification
GET/v1/merchants/me/api-keys
POST/v1/merchants/me/api-keys
POST/v1/merchants/me/api-keys/{keyId}/rotate
GET/v1/merchants/me
DELETE/v1/merchants/me/api-keys/{keyId}

FX Quotes

Create and retrieve locked FX quotes for send money flow

2 endpoints

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

User Provisioning - MTN Mobile Money (MoMo) API

Endpoints for creating and managing sandbox API users and API keys for MTN MoMo integration testing.

3 endpoints

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

Authentication

User registration and authentication

2 endpoints

MethodPath
POST/v1/auth/register
POST/v1/auth/forgot-password

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

Exchange Rates

FX rates and fee calculations for send money flow

1 endpoint

MethodPath
GET/v1/exchange-rates

Analytics

Merchant analytics and reporting

1 endpoint

MethodPath
GET/v1/merchants/me/analytics

User Profile

Manage the authenticated user's profile

3 endpoints

MethodPath
POST/v1/users/me/logout-all
GET/v1/users/me
PATCH/v1/users/me

Payment Methods

Manage saved payment methods for Stripe

5 endpoints

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

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

Authentication

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

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...

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

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

View all 106 models
AccountBalanceAccountPreApprovalsApiKeyResponseApiStatusApiUserApiUserKeyBasicUserInfoBcAuthorizeBcAuthorizeFormCancelInvoiceCashTransactionCashTransactionRequestCreateAgentRequestCreateApiKeyRequestCreateApiUserCreateCountryProviderRequestCreateCountryRequestCreateInvoiceRequestCreateMerchantRequestCreateMfiPartnerRequestCreatePaymentLinkRequestCreatePaymentRequestDTOCreateRecipientRequestCreateRoutingRuleRequestCreateSavingsGoalRequestCreateSavingsPlanRequestCreateWebhookEndpointRequestDeliveryNotificationDepositStatusErrorReasonFloatTopUpRequestForgotPasswordRequestFundInRequestFundInResponseFundOutRequestFundOutResponseFxQuoteRequestInvoiceInvoiceResponseInvoiceStatusKybSubmissionRequestKycDocumentUploadRequestKycReviewRequestKycUpgradeRequestLineItemLineItemRequestLoanApplicationRequestLoanRepaymentRequestLoanRepaymentResponseLoanResponseMerchantResponseMfiPartnerResponseMfiPoolDepositRequestMoneyOAuth2TokenOAuthTokenOauth2FormP2pTransferRequestP2pTransferResponsePageablePartyPaymentPaymentLinkCheckoutRequestPaymentLinkCheckoutResponsePaymentLinkResponsePaymentRequestResponsePaymentStatusPreApprovalPreApprovalStatusRecipientResponseRefundRequestRefundResponseRefundTransactionRefundTransactionStatusRegisterCustomerRequestRegistrationRequestReversalRequestSavingsDepositRequestSavingsDepositResponseSavingsGoalResponseSavingsPlanResponseSavingsWithdrawRequestSavingsWithdrawResponseSetDefaultPaymentMethodRequestSetupIntentResponseSeverityStatusInfoTestWebhookRequestToggleActiveRequestTransactionTransactionStatusTransferEventDtoTransferRequestTransferResponseUpdateAgentRequestUpdateCountryProviderRequestUpdateCountryRequestUpdatePaymentLinkRequestUpdateProfileRequestUpdateRecipientRequestUpdateRoundUpRequestUpdateRoutingRuleRequestUpdateSavingsPlanRequestUpdateStatusRequestUserInfoWebhookEndpointResponse

Full OpenAPI Specification

Download the complete OpenAPI 3.1.0 spec for use with Swagger UI, Postman, or code generators.

MTN MoMo Docs