# API Documentation

## Providus Bank API Documentation

- [Welcome!](https://developer.providusbank.com/welcome.md): Welcome to ProvidusBank API Documentation.
- [Quick Start](https://developer.providusbank.com/quick-start.md)
- [Account Statement](https://developer.providusbank.com/account-statement.md): Accounts APIs provide interfaces to manage customer accounts. The interface provides the following methods:
- [Get Providus Account Statement](https://developer.providusbank.com/account-statement/get-providus-account-statement.md): Get statement of transactions on an account.
- [Transactions](https://developer.providusbank.com/transactions.md): Transaction APIs provide interfaces to create and manage financial transactions. The interface provides the following methods:
- [Get API authorization code for transaction](https://developer.providusbank.com/transactions/get-api-authorization-code-for-transaction.md): Get an authorization code for the Transaction API.
- [Exchange authorization code for access token](https://developer.providusbank.com/transactions/exchange-authorization-code-for-access-token.md): Exchange authorization code for access token for the Transaction API.
- [Get Transaction Status](https://developer.providusbank.com/transactions/get-transaction-status.md): Get the status of a transaction.
- [Initiate a Transaction Request](https://developer.providusbank.com/transactions/initiate-a-transaction-request.md): Get statement of transactions on an account.
- [Provi Bill](https://developer.providusbank.com/provi-bill.md): Payment APIs provide interfaces to create and manage financial Payments. The interface provides the following methods:
- [Get Categories](https://developer.providusbank.com/provi-bill/get-categories.md)
- [Get Bills by Category](https://developer.providusbank.com/provi-bill/get-bills-by-category.md)
- [Get Field](https://developer.providusbank.com/provi-bill/get-field.md)
- [Validate](https://developer.providusbank.com/provi-bill/validate.md)
- [Payment](https://developer.providusbank.com/provi-bill/payment.md)
- [Payment Inquiry](https://developer.providusbank.com/provi-bill/payment-inquiry.md)
- [Digital Collection Services](https://developer.providusbank.com/digital-collection-services.md): Accounts APIs provide interfaces to manage customer accounts. The interface provides the following methods:
- [Blacklist/Whitelist Account](https://developer.providusbank.com/digital-collection-services/blacklist-whitelist-account.md): Blacklist accounts suspected of fraudulent activity to prevent funds from reaching your settlement account. Blacklisted accounts can receive funds, but notifications are not processed until whitelistd
- [Verify Transaction](https://developer.providusbank.com/digital-collection-services/verify-transaction.md): This endpoint is to verify a transaction by supplying the session id and credentials.
- [Get Providus Account](https://developer.providusbank.com/digital-collection-services/get-providus-account.md): Get a Providus bank user account.
- [Update Account Name](https://developer.providusbank.com/digital-collection-services/update-account-name.md): Endpoint update account name: This can be used when a virtual account is re-assigned and there is need to change the name of the account.
- [Verify Transaction by Session Id](https://developer.providusbank.com/digital-collection-services/verify-transaction-by-session-id.md): This is an enpoint to verify transactions by passing the settlement id.
- [Create Dynamic Account Number](https://developer.providusbank.com/digital-collection-services/create-dynamic-account-number.md): Endpoint Create Dynamic Account Number: This method is to create dynamic account number. Dynamic accounts are for one time payment after which the account goes inactive and ready to be reassigned, It
- [Create Reserved Account Number](https://developer.providusbank.com/digital-collection-services/create-reserved-account-number.md): Endpoint Create Reserved Account Number: This service can be used to create static/reserved accounts.
- [Verify Transaction by Settlement Id](https://developer.providusbank.com/digital-collection-services/verify-transaction-by-settlement-id.md): This is the end point to verify transactions by passing the session id.
- [Webhook Specification](https://developer.providusbank.com/digital-collection-services/webhook-specification.md): Your system must expose a webhook endpoint to receive transaction notifications from DCS. After receiving a notification, validate the X-Auth-Signature, settlementId, and accountNumber, then respond a
- [Transfer Services](https://developer.providusbank.com/transfer-services.md): This document provides detailed specifications for a RESTful web service designed to offer a secure integration interface for THIRD PARTY partners.
- [GetNIPAccount](https://developer.providusbank.com/transfer-services/getnipaccount.md): Validates the supplied account number and bank code (3-digit or 6-digit NIP bank code) and returns account details.
- [NIPFundTransfer](https://developer.providusbank.com/transfer-services/nipfundtransfer.md): Description: Transfers funds from a specified Providus account to another account in a different bank. The transactionReference must be unique for each transaction.
- [GetNIPTransactionStatus](https://developer.providusbank.com/transfer-services/getniptransactionstatus.md): Validates a single transaction reference and returns the current status of the transaction. It is recommended to perform a status re-query for 15 minutes to confirm the final status.
- [GetNIPBanks](https://developer.providusbank.com/transfer-services/getnipbanks.md): Returns a list of institutions enrolled on NIP with their respective bank codes.
- [ProvidusFundTransfer](https://developer.providusbank.com/transfer-services/providusfundtransfer.md): Transfers funds from a specified Providus account to another Providus account.
- [GetProvidusTransactionStatus](https://developer.providusbank.com/transfer-services/getprovidustransactionstatus.md): Validates a single transaction reference and returns the status of a Providus-to-Providus transaction. It is recommended to perform a status requery for 15 minutes to confirm the final status.
- [GetProvidusAccount](https://developer.providusbank.com/transfer-services/getprovidusaccount.md): Returns details, including balance, for the account tied to the username making the call.
- [NIPFundTransferMultipleDebitAccounts](https://developer.providusbank.com/transfer-services/nipfundtransfermultipledebitaccounts.md): Transfers funds from a specified settlement account to another account in a different bank, allowing flexibility to choose the debit account.
- [Xpress Wallet API](https://developer.providusbank.com/xpress-wallet-api.md)
- [Authentication](https://developer.providusbank.com/xpress-wallet-api/authentication.md)
- [Login](https://developer.providusbank.com/xpress-wallet-api/authentication/login.md)
- [Logout](https://developer.providusbank.com/xpress-wallet-api/authentication/logout.md)
- [Forget Password](https://developer.providusbank.com/xpress-wallet-api/authentication/forget-password.md)
- [Reset password](https://developer.providusbank.com/xpress-wallet-api/authentication/reset-password.md)
- [Refresh Token](https://developer.providusbank.com/xpress-wallet-api/authentication/refresh-token.md)
- [User](https://developer.providusbank.com/xpress-wallet-api/user.md)
- [Get user profile](https://developer.providusbank.com/xpress-wallet-api/user/get-user-profile.md)
- [Change user password](https://developer.providusbank.com/xpress-wallet-api/user/change-user-password.md)
- [Merchant](https://developer.providusbank.com/xpress-wallet-api/merchant.md)
- [Customers](https://developer.providusbank.com/xpress-wallet-api/merchant/customers.md)
- [Get All Customers](https://developer.providusbank.com/xpress-wallet-api/merchant/customers/get-all-customers.md)
- [Get Customer Details](https://developer.providusbank.com/xpress-wallet-api/merchant/customers/get-customer-details.md)
- [Find Customer by Phone Number](https://developer.providusbank.com/xpress-wallet-api/merchant/customers/find-customer-by-phone-number.md)
- [Update Customer Profile](https://developer.providusbank.com/xpress-wallet-api/merchant/customers/update-customer-profile.md)
- [Wallet](https://developer.providusbank.com/xpress-wallet-api/merchant/wallet.md)
- [Create Customer Wallet](https://developer.providusbank.com/xpress-wallet-api/merchant/wallet/create-customer-wallet.md)
- [Get All Wallets](https://developer.providusbank.com/xpress-wallet-api/merchant/wallet/get-all-wallets.md)
- [Transactions](https://developer.providusbank.com/xpress-wallet-api/merchant/transactions.md)
- [Transfer](https://developer.providusbank.com/xpress-wallet-api/merchant/transfer.md)
- [Get bank list](https://developer.providusbank.com/xpress-wallet-api/merchant/transfer/get-bank-list.md)
- [Get bank account details](https://developer.providusbank.com/xpress-wallet-api/merchant/transfer/get-bank-account-details.md)
- [Merchant bank transfer](https://developer.providusbank.com/xpress-wallet-api/merchant/transfer/merchant-bank-transfer.md)
- [Customer Bank Transfer](https://developer.providusbank.com/xpress-wallet-api/merchant/transfer/customer-bank-transfer.md)
- [Merchant Batch Bank Transfer](https://developer.providusbank.com/xpress-wallet-api/merchant/transfer/merchant-batch-bank-transfer.md)
- [Customer to Customer Wallet Transfer](https://developer.providusbank.com/xpress-wallet-api/merchant/transfer/customer-to-customer-wallet-transfer.md)
- [Card](https://developer.providusbank.com/xpress-wallet-api/merchant/card.md)
- [Card Setup](https://developer.providusbank.com/xpress-wallet-api/merchant/card/card-setup.md)
- [Create Card](https://developer.providusbank.com/xpress-wallet-api/merchant/card/create-card.md)
- [Activate Card](https://developer.providusbank.com/xpress-wallet-api/merchant/card/activate-card.md)
- [Get Card Balance](https://developer.providusbank.com/xpress-wallet-api/merchant/card/get-card-balance.md)
- [Fund Card](https://developer.providusbank.com/xpress-wallet-api/merchant/card/fund-card.md)
- [Team](https://developer.providusbank.com/xpress-wallet-api/merchant/team.md)
- [Invite Team Member](https://developer.providusbank.com/xpress-wallet-api/merchant/team/invite-team-member.md)
- [Get Team Members](https://developer.providusbank.com/xpress-wallet-api/merchant/team/get-team-members.md)
- [Get All Invitations](https://developer.providusbank.com/xpress-wallet-api/merchant/team/get-all-invitations.md)
- [Resend Invitation](https://developer.providusbank.com/xpress-wallet-api/merchant/team/resend-invitation.md)
- [Accept Invitation](https://developer.providusbank.com/xpress-wallet-api/merchant/team/accept-invitation.md)
- [Get Merchant List](https://developer.providusbank.com/xpress-wallet-api/merchant/team/get-merchant-list.md)
- [Switch Merchant](https://developer.providusbank.com/xpress-wallet-api/merchant/team/switch-merchant.md)
- [Update Member Information](https://developer.providusbank.com/xpress-wallet-api/merchant/team/update-member-information.md)
- [Roles & Permission](https://developer.providusbank.com/xpress-wallet-api/merchant/roles-and-permission.md)
- [Get All Permissions](https://developer.providusbank.com/xpress-wallet-api/merchant/roles-and-permission/get-all-permissions.md)
- [Get All Roles](https://developer.providusbank.com/xpress-wallet-api/merchant/roles-and-permission/get-all-roles.md)
- [Create Role](https://developer.providusbank.com/xpress-wallet-api/merchant/roles-and-permission/create-role.md)
- [Update Role](https://developer.providusbank.com/xpress-wallet-api/merchant/roles-and-permission/update-role.md)
- [Account verification](https://developer.providusbank.com/xpress-wallet-api/merchant/account-verification.md)
- [Resend Verification Code](https://developer.providusbank.com/xpress-wallet-api/merchant/resend-verification-code.md)
- [Complete Merchant KYC](https://developer.providusbank.com/xpress-wallet-api/merchant/complete-merchant-kyc.md)
- [Get Merchant Profile](https://developer.providusbank.com/xpress-wallet-api/merchant/get-merchant-profile.md)
- [Update Merchant Profile](https://developer.providusbank.com/xpress-wallet-api/merchant/update-merchant-profile.md)
- [Get Merchant Access Keys](https://developer.providusbank.com/xpress-wallet-api/merchant/get-merchant-access-keys.md)
- [Generate Access Keys](https://developer.providusbank.com/xpress-wallet-api/merchant/generate-access-keys.md)
- [Switch Account Mode](https://developer.providusbank.com/xpress-wallet-api/merchant/switch-account-mode.md)
- [Merchant Registration](https://developer.providusbank.com/xpress-wallet-api/merchant/merchant-registration.md)
- [Get Merchant Wallet](https://developer.providusbank.com/xpress-wallet-api/merchant/get-merchant-wallet.md)
- [Code Samples](https://developer.providusbank.com/xpress-wallet-api/code-samples.md)
- [API Reference](https://developer.providusbank.com/reference/api-reference.md)
- [Authentication](https://developer.providusbank.com/reference/api-reference/authentication.md)
- [OAuth 2.0 Authentication](https://developer.providusbank.com/reference/api-reference/oauth-2.0-authentication.md)
- [Error Handling](https://developer.providusbank.com/reference/api-reference/error-handling.md)
- [Data Formats](https://developer.providusbank.com/reference/api-reference/data-formats.md)
- [Sandbox](https://developer.providusbank.com/reference/sandbox.md): Welcome to Our API Playground!
- [Advanced Setup of Postman for API Sandbox](https://developer.providusbank.com/reference/sandbox/advanced-setup-of-postman-for-api-sandbox.md)
- [Advanced Setup for API Development and Testing](https://developer.providusbank.com/reference/sandbox/advanced-setup-for-api-development-and-testing.md)