API Documentation v1.0

MANAGE YOUR
PAYMENTS

Nkapsmart provides a unified interface to accept local and international payments in a single integration.

Base Endpoint

https://api.nkapsmart.cm

API Key Management

To interact with the Nkapsmart infrastructure, you handle three types of identifiers. It is crucial to understand their role to secure your integration.

Application Key (Public)

This is your application's unique identifier. It can be exposed in your requests without risk.

Usage :Used to identify the entity during authentication and in some Webhooks.

Secret Key (Private / Signature)

This is your HMAC signing key. It must NEVER travel across the network.

Usage :Used exclusively to generate the hash (signature) needed to obtain an Access Token. If it is compromised, revoke it immediately.

Access Token (Temporary JWT)

This is the dynamic token obtained after a successful authentication.

Usage :Must be included in the 'Authorization' header of ALL your API calls to our services.

Important Recovery Note

The Application Key is always visible in your dashboard. However, the Secret Key is only displayed once (at creation). If you lose it, you will need to generate a new key pair.

Authentication & Security

Secure your API calls using an HMAC-SHA256 signature generated from your application keys.

Besoin d'aide sur les clés ?

Avant de commencer, familiarisez-vous avec la différence entre Application Key, Secret Key et AccessToken dans notre guide de Gestion des clés.

Signature Generation

stringToSign = METHOD + "\n" + PATH + "\n" + TIMESTAMP + "\n" + Base64(SHA256(body))
signature = Base64( HMAC-SHA256(secret, stringToSign) )

The timestamp must be within a ±5 minute window of the server's UTC time.

The signature is calculated as follows:

METHODPOST

PATH/api/auth/authenticate

TIMESTAMPUnix UTC Timestamp in seconds (e.g., 1745055000)

BODYEmpty string "" for this endpoint

SECRETThe plainTextSecret value received when creating the API key

Request Parameters

Field	Type	Required
apiKey	string (Your API Key)	YES
signature	string (HMAC-SHA256)	YES
timestamp	number (Unix UTC)	YES

Success Response (200 OK)

Returns the JWT access token and user details.

JSON Response

{
  "accessToken": "eyJh... (JWT Token)",
  "tokenType": "Bearer",
  "expiresAt": 1745058600,
  "userId": "3fa85f64..."
}

accessToken:The JWT token used to authenticate your future API calls.

tokenType:The type of token (Bearer).

expiresAt:The UTC timestamp when the token expires.

userId:Your account's unique identifier.

Token Usage (Bearer Auth)

The accessToken is critical for security. Once obtained, it must be included in the Header of ALL subsequent requests (payments, withdrawals, etc.).

Authorization: Bearer [your_access_token]

This allows you to securely prove your identity without re-signing or re-transmitting your secret keys for every action.

POST/api/auth/authenticate

NODEJS IMPLEMENTATION

const crypto = require('crypto');

const secret = 'your_plain_text_secret';
const method = 'POST';
const path = '/api/auth/authenticate';
const body = '';
const timestamp = Math.floor(Date.now() / 1000).toString();

const bodyHash = crypto.createHash('sha256').update(body).digest('base64');
const stringToSign = `${method}\n${path}\n${timestamp}\n${bodyHash}`;
const signature = crypto.createHmac('sha256', secret).update(stringToSign).digest('base64');

// Send { apiKey, signature, timestamp: parseInt(timestamp) }

Key Protection

Never share your Secret Key. If your keys are compromised, revoke them immediately from the KeysPage.

Mobile Payment

Initialize a mobile payment transaction.

How Mobile Money payments work

When a customer chooses Mobile Money as payment method, a push notification is sent to their registered mobile device. To complete the transaction, the customer must:

•Open the notification on their mobile device.
•Authorize the payment by entering their PIN code or following the provider's authentication process.

Once authorized, the payment is processed, and both the customer and merchant receive a confirmation. The customer's Mobile Money wallet is debited and a successful webhook notification is sent to your server.

Payment Workflow

Customer

Enters the number and amount.

System

Verifies the recipient's identity (user_name).

Backend

Validates the business balance and initiates the request.

Operator

Sends the USSD push to the customer's mobile.

Customer

Confirms with their PIN code.

System

Receives the Webhook and confirms the transaction.

Field	Type	Required
phoneNumber	string	YES
amount	double	YES
email	string	YES
applicationKey	string	YES
description	string	NO
productName	string	NO

POST/api/v2/TransactionSecond/mobile

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@mail.com",
  "applicationKey": "YOUR_KEY",
  "description": "...",
  "productName": "..."
}

Note: Ensure your server is listening for the charge.completed webhook to deliver value.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Bank Payment

Initiate payments via bank transfer. This endpoint generates a secure payment session allowing the customer to finalize the transaction through their banking interface.

Bank Payment Process

The bank flow relies on a redirect or transfer instruction. Once the request is sent, the system processes the authorization with the partner bank.

The customer is redirected to their bank's interface if necessary.
On success, they are redirected to your SuccessUrl.
On cancellation, they return to your CancelUrl.

Bank Workflow

Customer

Enters their information and transfer amount.

System

Validates the application key and registers the payment intent.

Backend

Generates redirect links (Success/Cancel).

Bank

Checks fund availability and authorizes the transfer.

Customer

Is redirected to the success URL after confirmation.

System

Notifies your server via Webhook (charge.completed).

Field	Type	Required
phoneNumber	string	NO
amount	double	YES
email	string	YES
applicationKey	string	YES
productName	string	NO
Description	string	NO
SuccessUrl	string	NO
CancelUrl	string	NO

POST/api/Transaction/bank

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@mail.com",
  "applicationKey": "YOUR_KEY",
  "productName": "....",
  "Description": "....",
  "SuccessUrl": "....",
  "CancelUrl": "...."
}

Note de sécurité : Make sure the redirect URLs are publicly accessible to allow customer return.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Crypto Payment (USDT)

Accept USDT payments networks. This flow requires a valid payment address for receiving funds.

How Crypto Flow Works

Crypto payment relies on verifying the transaction on the blockchain.

The system generates a payment intent for the amount specified in payCurrency.
The user must send the exact funds to the address provided in paymentAddress.
Confirmation is automatic once the required number of blocks is reached on the network.

Web3 / Crypto Workflow

Customer

Selects the currency.

System

Validates the receiving address and amount.

Backend

Locks the exchange rate and waits for the deposit.

Blockchain

Verifies the transaction on the selected network.

System

Detects the incoming transfer via the payment address.

Merchant

Receives the success notification after confirmation.

Field	Type	Required
phoneNumber	string	NO
amount	double	YES
email	string	YES
applicationKey	string	YES
description	string	NO
payCurrency	string	YES
productName	string	NO
paymentAddress	string	YES

POST/api/v2/TransactionSecond/crypto

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@example.com",
  "applicationKey": "YOUR_KEY",
  "description": "....",
  "payCurrency": "...",
  "productName": "....",
  "paymentAddress": "...."
}

Blockchain Security : Warning: Any error in the payment address (paymentAddress) or network (payCurrency) may result in permanent loss of funds.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Mobile Withdraw

Use this endpoint to send funds from your business account to a recipient's Mobile Money wallet in Cameroon.

How withdrawal works

Unlike payment, Withdraw is an outgoing operation. Money is debited from your balance to credit a third party.

The system verifies that your Application Key has sufficient balance.
The recipient receives funds directly into their MTN or Orange account.
It is crucial to provide the recieverName to ensure accounting traceability.

Withdrawal Workflow

System

Receives the withdrawal request with recipient information.

Backend

Checks account eligibility and available balance.

Operator

Executes the transfer to the provided phone number.

System

Updates the transaction status and your balance.

Field	Type	Required
phoneNumber	string	YES
amount	double	YES
email	string	YES
applicationKey	string	YES
description	string	NO
recieverName	string	NO
operator	int	YES

POST/api/v2/TransactionSecond/mobile/widraw

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@example.com",
  "applicationKey": "YOUR_KEY",
  "description": "....",
  "recieverName": "....",
  "operator": 0
}

Important : Note: The withdrawal is processed immediately by the provider. Make sure you have sufficient balance to avoid 403/400 errors.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Withdrawal (Crypto & USDT)

Transfer tokens to an external wallet. This network offers near-instant transactions with minimal fees.

Specificity

The withdrawal is made directly on the Mainnet. Make sure the destination address is compatible.

Average time: ~2 minutes

Field	Type	Required
phoneNumber	string	YES
amount	double	YES
email	string	YES
applicationKey	string	YES
description	string	YES
payCurrency	string	YES
payeeAddress	string	YES

POST/api/v2/TransactionSecond/crypto/widraw

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@mail.com",
  "applicationKey": "YOUR_KEY",
  "description": "....",
  "payCurrency": "....",
  "payeeAddress": "...."
}

Endpoint: Crypto Withdraw (Matic)

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Bulk Withdraw

Send money to multiple recipients simultaneously. Ideal for automating payroll or reward campaigns.

How Bulk Mode Works

Instead of calling the API for each person, you send a transactions.

The system first validates that your balance covers the total amount of the batch.
Each transaction is processed asynchronously.
The API returns a bulkOperationId to track overall progress.

Field	Structure	Required
applicationKey	string	YES
transactions	Array<Object>	YES

Transaction Object Fields

Field	Type	Required	Description
phoneNumber	string	YES	Recipient's phone number
amount	double	YES	Amount to transfer
email	string	NO	Recipient's email
description	string	NO	Transaction description
recieverName	string	NO	Recipient's full name

POST/api/v2/TransactionSecond/mobile/withdraw/bulk

{
  "applicationKey": "YOUR_KEY",
  "transactions": [
    {
      "phoneNumber": "6XXXXXXXX",
      "amount": 0,
      "email": "user1@example.com",
      "description": "...",
      "recieverName": "...."
    }
  ]
}

Limitation : Pour des raisons de performance, nous recommandons de ne pas dépasser 100 transactions par lot (Bulk).

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Bulk Withdraw Status

Use this endpoint to track the progress of a bulk operation. You will get a global summary as well as the individual status of each transaction.

Understanding Statuses

PENDING : The batch is being processed by operators (MTN/Orange).

COMPLETED : All transactions in the batch have been finalized (Success or Failure).

PARTIAL : Some transactions have failed (e.g., insufficient balance or invalid number).

URL Parameters

URL Parameter	Type	Required	Description
bulkOperationId	string	YES	The ID returned when the bulk operation was created

Response Fields

Field	Type	Required	Description
bulkOperationId	string	Yes	Unique batch identifier
totalCount	int	Yes	Total transactions in batch
successCount	int	Yes	Number of successful transactions
failedCount	int	Yes	Number of failed transactions
pendingCount	int	Yes	Number of transactions still processing
status	string	Yes	Overall batch status (Pending, Completed, Partial)
createdAt	datetime	Yes	Creation date
updatedAt	datetime	Yes	Last update date

Transaction Object Fields

Field	Type	Required	Description
id	string	Yes	Unique transaction ID
phoneNumber	string	Yes	Recipient phone number
amount	double	Yes	Transaction amount
email	string	Yes	Recipient email
description	string	Yes	Internal description
status	string	Yes	Individual transaction status
transactionKey	string	Yes	External bank/operator reference key
errorMessage	string	Yes	Error details if failed
createdAt	datetime	Yes	Timestamp

GET/api/v2/TransactionSecond/mobile/widraw/bulk/{bulkOperationId}

JSON Response Example

{
  "bulkOperationId": "BK-2026-X99",
  "totalCount": 2,
  "successCount": 1,
  "failedCount": 1,
  "pendingCount": 0,
  "status": "Completed",
  "createdAt": "2026-06-05T09:59:22.660Z",
  "updatedAt": "2026-06-05T09:59:22.660Z",
  "transactions": [
    {
      "id": "uuid-123",
      "phoneNumber": "6XXXXXXXX",
      "amount": 5000,
      "email": "user@example.com",
      "description": "Payment",
      "status": "Success",
      "transactionKey": "KEY123",
      "errorMessage": "",
      "createdAt": "2026-06-05T09:59:22.660Z"
    }
  ]
}

Pro Tip: Don't poll this endpoint too quickly. We recommend an interval of 5 to 10 seconds between each status check to optimize your performance.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Standard Verification

Check the status of a Mobile Money or Bank payment. This endpoint queries the final status directly from the concerned operator.

When to call this endpoint?

If you haven't received the confirmation Webhook.
When a customer returns to your SuccessUrl to validate their purchase.
To resolve doubt about a pending transaction.

URL Parameters

URL Parameter	Type	Required
transactionkey	string	YES

Response Fields

Field	Type	Required	Description
transactionReference	string	Yes	Unique reference for the transaction
transactionAmount	double	Yes	Amount to be paid
transactionDescription	string	Yes	Short summary of the purchase
walletToken	string	Yes	Internal token for wallet referencing
transactionType	string	Yes	Type of transaction (Payment, etc.)
transactionCategory	string	Yes	Category of the transaction
successUrl	string	Yes	URL to redirect on success
cancelUrl	string	Yes	URL to redirect on cancellation
transactionKey	string	Yes	Unique technical identifier
productName	string	No	Name of the product purchased
transactionStatus	string	Yes	Current status (SUCCESS, FAILED, PENDING)
paymentUrl	string	Yes	Link to the payment gateway
raison	string	No	Detailed reason in case of failure
cryptoPayAmount	double	No	Amount in cryptocurrency (if applicable)
paymentAddress	string	No	Sender crypto address
payeeAddress	string	No	Recipient crypto address
ash	string	No	Transaction hash on the blockchain
createdAt	datetime	Yes	Transaction creation date

Customer Details (Contact)

Field	Type	Required	Description
id	string	Yes	Contact unique identifier
phoneNumber	string	Yes	Customer's mobile number
email	string	Yes	Customer's email address
address	string	No	Physical address
city	string	No	Customer's city
state	string	No	State or region
country	string	No	Customer's country
zipCode	string	No	Postal code

History (Inner Transactions)

Field	Type	Required	Description
id	string	Yes	Transaction unique identifier
transactionType	string	Yes	Type of transaction
transactionStatus	string	Yes	Status of the individual transaction
operator	string	Yes	Operator used (MTN, Orange, etc.)
transactionAmount	double	Yes	Total amount
transactionWithOutFees	double	Yes	Net amount without fees
transactionReference	string	Yes	Merchant reference
transactionKey	string	Yes	Technical key
transactionDescription	string	Yes	Description
paymentUrl	string	No	Payment link
faildRaison	string	No	Failure details
ash	string	No	Blockchain hash
createdAt	datetime	Yes	Timestamp

GET/api/v2/TransactionSecond/verify/{transactionkey}/{ash}

Response Body

{
  "transactionReference": "string",
  "transactionAmount": 0,
  "transactionDescription": "string",
  "walletToken": "string",
  "transactionType": "string",
  "transactionCategory": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "transactionKey": "string",
  "productName": "string",
  "transactionContact": {
    "id": "string",
    "address": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "phoneNumber": "string",
    "email": "string",
    "transactions": [
      {
        "id": "string",
        "transactionType": 0,
        "transactionStatus": 0,
        "operator": 0,
        "transactionAmount": 0,
        "transactionWithOutFees": 0,
        "transactionReference": "string",
        "transactionKey": "string",
        "walletToken": "string",
        "transactionDescription": "string",
        "successUrl": "string",
        "cancelUrl": "string",
        "productName": "string",
        "paymentUrl": "string",
        "faildRaison": "string",
        "description": "string",
        "payCurrency": "string",
        "payAmount": 0,
        "ash": "string",
        "transactionContactId": "string",
        "transactionCategory": 0,
        "transactionContact": "string",
        "paymentAddress": "string",
        "realAmount": 0,
        "payeeAddress": "string",
        "businnesId": "string",
        "business": {
          "id": "string",
          "name": "string",
          "description": "string",
          "returnUrl": "string",
          "callbackUrl": "string",
          "logoUrl": "string",
          "allowIp": "string",
          "balance": 0,
          "activateEmail": true,
          "prevWidrawAmount": 0,
          "transactionFees": 0,
          "userId": "string",
          "user": {
            "id": "string",
            "userName": "string",
            "normalizedUserName": "string",
            "email": "string",
            "normalizedEmail": "string",
            "emailConfirmed": true,
            "passwordHash": "string",
            "securityStamp": "string",
            "concurrencyStamp": "string",
            "phoneNumber": "string",
            "phoneNumberConfirmed": true,
            "twoFactorEnabled": true,
            "lockoutEnd": "2026-06-05T10:17:07.235Z",
            "lockoutEnabled": true,
            "accessFailedCount": 0,
            "fullName": "string",
            "enterpriseName": "string",
            "websiteUrl": "string",
            "status": 0,
            "logoName": "string",
            "nuiValue": "string",
            "type": 0,
            "cardId": "string",
            "card": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "niuId": "string",
            "niu": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "commercialRegisterId": "string",
            "commercialRegister": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "taxSheetId": "string",
            "taxSheet": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "ribId": "string",
            "rib": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "widrawCountTransaction": 0,
            "createdAt": "2026-06-05T10:17:07.236Z",
            "updatedAt": "2026-06-05T10:17:07.236Z"
          },
          "businessOperatorBalance": [
            {
              "id": "string",
              "businessId": "string",
              "operator": 0,
              "amount": 0,
              "createdAt": "2026-06-05T10:17:07.236Z",
              "updatedAt": "2026-06-05T10:17:07.236Z"
            }
          ],
          "createdAt": "2026-06-05T10:17:07.236Z",
          "updatedAt": "2026-06-05T10:17:07.236Z"
        },
        "createdAt": "2026-06-05T10:17:07.236Z",
        "updatedAt": "2026-06-05T10:17:07.236Z",
        "bulkOperationId": "string"
      }
    ]
  },
  "transactionStatus": "string",
  "paymentUrl": "string",
  "raison": "string",
  "cryptoPayAmount": 0,
  "paymentAddress": "string",
  "payeeAddress": "string",
  "ash": "string",
  "createdAt": "2026-06-05T10:17:07.236Z"
}

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Crypto Verification

Verify the status of a completed or pending crypto transaction.

IMPORTANT

The parameter ash corresponds to the Transaction ash (TXID) generated by the network. Without this ash, verification cannot be completed.

URL Parameters

URL Parameter	Type	Required
transactionkey	string	YES
ash	string	YES

Response Fields

Field	Type	Required	Description
transactionReference	string	Yes	Unique reference for the transaction
transactionAmount	double	Yes	Amount to be paid
transactionDescription	string	Yes	Short summary of the purchase
walletToken	string	Yes	Internal token for wallet referencing
transactionType	string	Yes	Type of transaction
transactionCategory	string	Yes	Category of the transaction
successUrl	string	Yes	URL to redirect on success
cancelUrl	string	Yes	URL to redirect on cancellation
transactionKey	string	Yes	Unique technical identifier
productName	string	No	Name of the product purchased
transactionStatus	string	Yes	Current status (SUCCESS, FAILED, PENDING)
paymentUrl	string	Yes	Link to the payment gateway
raison	string	No	Detailed reason in case of failure
cryptoPayAmount	double	No	Amount in cryptocurrency
paymentAddress	string	No	Sender crypto address
payeeAddress	string	No	Recipient crypto address
ash	string	No	Transaction hash on the blockchain
createdAt	datetime	Yes	Transaction creation date

Customer Details (Contact)

Field	Type	Required	Description
id	string	Yes	Contact unique identifier
phoneNumber	string	Yes	Customer's mobile number
email	string	Yes	Customer's email address
address	string	No	Physical address
city	string	No	Customer's city
state	string	No	State or region
country	string	No	Customer's country
zipCode	string	No	Postal code

History (Inner Transactions)

Field	Type	Required	Description
id	string	Yes	Transaction unique identifier
transactionType	string	Yes	Type of transaction
transactionStatus	string	Yes	Status of the individual transaction
operator	string	Yes	Operator used (MTN, Orange, etc.)
transactionAmount	double	Yes	Total amount
transactionWithOutFees	double	Yes	Net amount without fees
transactionReference	string	Yes	Merchant reference
transactionKey	string	Yes	Technical key
transactionDescription	string	Yes	Description
paymentUrl	string	No	Payment link
faildRaison	string	No	Failure details
ash	string	No	Blockchain hash
createdAt	datetime	Yes	Timestamp

GET/api/v2/TransactionSecond/verify/{transactionkey}/{ash}

Response Body

{
  "transactionReference": "string",
  "transactionAmount": 0,
  "transactionDescription": "string",
  "walletToken": "string",
  "transactionType": "string",
  "transactionCategory": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "transactionKey": "string",
  "productName": "string",
  "transactionContact": {
    "id": "string",
    "address": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "phoneNumber": "string",
    "email": "string",
    "transactions": [
      {
        "id": "string",
        "transactionType": 0,
        "transactionStatus": 0,
        "operator": 0,
        "transactionAmount": 0,
        "transactionWithOutFees": 0,
        "transactionReference": "string",
        "transactionKey": "string",
        "walletToken": "string",
        "transactionDescription": "string",
        "successUrl": "string",
        "cancelUrl": "string",
        "productName": "string",
        "paymentUrl": "string",
        "faildRaison": "string",
        "description": "string",
        "payCurrency": "string",
        "payAmount": 0,
        "ash": "string",
        "transactionContactId": "string",
        "transactionCategory": 0,
        "transactionContact": "string",
        "paymentAddress": "string",
        "realAmount": 0,
        "payeeAddress": "string",
        "businnesId": "string",
        "business": {
          "id": "string",
          "name": "string",
          "description": "string",
          "returnUrl": "string",
          "callbackUrl": "string",
          "logoUrl": "string",
          "allowIp": "string",
          "balance": 0,
          "activateEmail": true,
          "prevWidrawAmount": 0,
          "transactionFees": 0,
          "userId": "string",
          "user": {
            "id": "string",
            "userName": "string",
            "normalizedUserName": "string",
            "email": "string",
            "normalizedEmail": "string",
            "emailConfirmed": true,
            "passwordHash": "string",
            "securityStamp": "string",
            "concurrencyStamp": "string",
            "phoneNumber": "string",
            "phoneNumberConfirmed": true,
            "twoFactorEnabled": true,
            "lockoutEnd": "2026-06-05T10:29:52.518Z",
            "lockoutEnabled": true,
            "accessFailedCount": 0,
            "fullName": "string",
            "enterpriseName": "string",
            "websiteUrl": "string",
            "status": 0,
            "logoName": "string",
            "nuiValue": "string",
            "type": 0,
            "cardId": "string",
            "card": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "niuId": "string",
            "niu": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "commercialRegisterId": "string",
            "commercialRegister": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "taxSheetId": "string",
            "taxSheet": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "ribId": "string",
            "rib": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "widrawCountTransaction": 0,
            "createdAt": "2026-06-05T10:29:52.518Z",
            "updatedAt": "2026-06-05T10:29:52.518Z"
          },
          "businessOperatorBalance": [
            {
              "id": "string",
              "businessId": "string",
              "operator": 0,
              "amount": 0,
              "createdAt": "2026-06-05T10:29:52.518Z",
              "updatedAt": "2026-06-05T10:29:52.518Z"
            }
          ],
          "createdAt": "2026-06-05T10:29:52.518Z",
          "updatedAt": "2026-06-05T10:29:52.518Z"
        },
        "createdAt": "2026-06-05T10:29:52.518Z",
        "updatedAt": "2026-06-05T10:29:52.518Z",
        "bulkOperationId": "string"
      }
    ]
  },
  "transactionStatus": "string",
  "paymentUrl": "string",
  "raison": "string",
  "cryptoPayAmount": 0,
  "paymentAddress": "string",
  "payeeAddress": "string",
  "ash": "string",
  "createdAt": "2026-06-05T10:29:52.518Z"
}

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Nkapsmart is warming up...

API Documentation v1.0

MANAGE YOUR
PAYMENTS

Nkapsmart provides a unified interface to accept local and international payments in a single integration.

Base Endpoint

https://api.nkapsmart.cm

API Key Management

To interact with the Nkapsmart infrastructure, you handle three types of identifiers. It is crucial to understand their role to secure your integration.

Application Key (Public)

This is your application's unique identifier. It can be exposed in your requests without risk.

Usage :Used to identify the entity during authentication and in some Webhooks.

Secret Key (Private / Signature)

This is your HMAC signing key. It must NEVER travel across the network.

Usage :Used exclusively to generate the hash (signature) needed to obtain an Access Token. If it is compromised, revoke it immediately.

Access Token (Temporary JWT)

This is the dynamic token obtained after a successful authentication.

Usage :Must be included in the 'Authorization' header of ALL your API calls to our services.

Important Recovery Note

The Application Key is always visible in your dashboard. However, the Secret Key is only displayed once (at creation). If you lose it, you will need to generate a new key pair.

Authentication & Security

Secure your API calls using an HMAC-SHA256 signature generated from your application keys.

Besoin d'aide sur les clés ?

Avant de commencer, familiarisez-vous avec la différence entre Application Key, Secret Key et AccessToken dans notre guide de Gestion des clés.

Signature Generation

stringToSign = METHOD + "\n" + PATH + "\n" + TIMESTAMP + "\n" + Base64(SHA256(body))
signature = Base64( HMAC-SHA256(secret, stringToSign) )

The timestamp must be within a ±5 minute window of the server's UTC time.

The signature is calculated as follows:

METHODPOST

PATH/api/auth/authenticate

TIMESTAMPUnix UTC Timestamp in seconds (e.g., 1745055000)

BODYEmpty string "" for this endpoint

SECRETThe plainTextSecret value received when creating the API key

Request Parameters

Field	Type	Required
apiKey	string (Your API Key)	YES
signature	string (HMAC-SHA256)	YES
timestamp	number (Unix UTC)	YES

Success Response (200 OK)

Returns the JWT access token and user details.

JSON Response

{
  "accessToken": "eyJh... (JWT Token)",
  "tokenType": "Bearer",
  "expiresAt": 1745058600,
  "userId": "3fa85f64..."
}

accessToken:The JWT token used to authenticate your future API calls.

tokenType:The type of token (Bearer).

expiresAt:The UTC timestamp when the token expires.

userId:Your account's unique identifier.

Token Usage (Bearer Auth)

The accessToken is critical for security. Once obtained, it must be included in the Header of ALL subsequent requests (payments, withdrawals, etc.).

Authorization: Bearer [your_access_token]

This allows you to securely prove your identity without re-signing or re-transmitting your secret keys for every action.

POST/api/auth/authenticate

NODEJS IMPLEMENTATION

const crypto = require('crypto');

const secret = 'your_plain_text_secret';
const method = 'POST';
const path = '/api/auth/authenticate';
const body = '';
const timestamp = Math.floor(Date.now() / 1000).toString();

const bodyHash = crypto.createHash('sha256').update(body).digest('base64');
const stringToSign = `${method}\n${path}\n${timestamp}\n${bodyHash}`;
const signature = crypto.createHmac('sha256', secret).update(stringToSign).digest('base64');

// Send { apiKey, signature, timestamp: parseInt(timestamp) }

Key Protection

Never share your Secret Key. If your keys are compromised, revoke them immediately from the KeysPage.

Mobile Payment

Initialize a mobile payment transaction.

How Mobile Money payments work

When a customer chooses Mobile Money as payment method, a push notification is sent to their registered mobile device. To complete the transaction, the customer must:

•Open the notification on their mobile device.
•Authorize the payment by entering their PIN code or following the provider's authentication process.

Payment Workflow

Customer

Enters the number and amount.

System

Verifies the recipient's identity (user_name).

Backend

Validates the business balance and initiates the request.

Operator

Sends the USSD push to the customer's mobile.

Customer

Confirms with their PIN code.

System

Receives the Webhook and confirms the transaction.

Field	Type	Required
phoneNumber	string	YES
amount	double	YES
email	string	YES
applicationKey	string	YES
description	string	NO
productName	string	NO

POST/api/v2/TransactionSecond/mobile

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@mail.com",
  "applicationKey": "YOUR_KEY",
  "description": "...",
  "productName": "..."
}

Note: Ensure your server is listening for the charge.completed webhook to deliver value.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Bank Payment

Initiate payments via bank transfer. This endpoint generates a secure payment session allowing the customer to finalize the transaction through their banking interface.

Bank Payment Process

The bank flow relies on a redirect or transfer instruction. Once the request is sent, the system processes the authorization with the partner bank.

The customer is redirected to their bank's interface if necessary.
On success, they are redirected to your SuccessUrl.
On cancellation, they return to your CancelUrl.

Bank Workflow

Customer

Enters their information and transfer amount.

System

Validates the application key and registers the payment intent.

Backend

Generates redirect links (Success/Cancel).

Bank

Checks fund availability and authorizes the transfer.

Customer

Is redirected to the success URL after confirmation.

System

Notifies your server via Webhook (charge.completed).

Field	Type	Required
phoneNumber	string	NO
amount	double	YES
email	string	YES
applicationKey	string	YES
productName	string	NO
Description	string	NO
SuccessUrl	string	NO
CancelUrl	string	NO

POST/api/Transaction/bank

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@mail.com",
  "applicationKey": "YOUR_KEY",
  "productName": "....",
  "Description": "....",
  "SuccessUrl": "....",
  "CancelUrl": "...."
}

Note de sécurité : Make sure the redirect URLs are publicly accessible to allow customer return.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Crypto Payment (USDT)

Accept USDT payments networks. This flow requires a valid payment address for receiving funds.

How Crypto Flow Works

Crypto payment relies on verifying the transaction on the blockchain.

The system generates a payment intent for the amount specified in payCurrency.
The user must send the exact funds to the address provided in paymentAddress.
Confirmation is automatic once the required number of blocks is reached on the network.

Web3 / Crypto Workflow

Customer

Selects the currency.

System

Validates the receiving address and amount.

Backend

Locks the exchange rate and waits for the deposit.

Blockchain

Verifies the transaction on the selected network.

System

Detects the incoming transfer via the payment address.

Merchant

Receives the success notification after confirmation.

Field	Type	Required
phoneNumber	string	NO
amount	double	YES
email	string	YES
applicationKey	string	YES
description	string	NO
payCurrency	string	YES
productName	string	NO
paymentAddress	string	YES

POST/api/v2/TransactionSecond/crypto

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@example.com",
  "applicationKey": "YOUR_KEY",
  "description": "....",
  "payCurrency": "...",
  "productName": "....",
  "paymentAddress": "...."
}

Blockchain Security : Warning: Any error in the payment address (paymentAddress) or network (payCurrency) may result in permanent loss of funds.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Mobile Withdraw

Use this endpoint to send funds from your business account to a recipient's Mobile Money wallet in Cameroon.

How withdrawal works

Unlike payment, Withdraw is an outgoing operation. Money is debited from your balance to credit a third party.

The system verifies that your Application Key has sufficient balance.
The recipient receives funds directly into their MTN or Orange account.
It is crucial to provide the recieverName to ensure accounting traceability.

Withdrawal Workflow

System

Receives the withdrawal request with recipient information.

Backend

Checks account eligibility and available balance.

Operator

Executes the transfer to the provided phone number.

System

Updates the transaction status and your balance.

Field	Type	Required
phoneNumber	string	YES
amount	double	YES
email	string	YES
applicationKey	string	YES
description	string	NO
recieverName	string	NO
operator	int	YES

POST/api/v2/TransactionSecond/mobile/widraw

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@example.com",
  "applicationKey": "YOUR_KEY",
  "description": "....",
  "recieverName": "....",
  "operator": 0
}

Important : Note: The withdrawal is processed immediately by the provider. Make sure you have sufficient balance to avoid 403/400 errors.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Withdrawal (Crypto & USDT)

Transfer tokens to an external wallet. This network offers near-instant transactions with minimal fees.

Specificity

The withdrawal is made directly on the Mainnet. Make sure the destination address is compatible.

Average time: ~2 minutes

Field	Type	Required
phoneNumber	string	YES
amount	double	YES
email	string	YES
applicationKey	string	YES
description	string	YES
payCurrency	string	YES
payeeAddress	string	YES

POST/api/v2/TransactionSecond/crypto/widraw

{
  "phoneNumber": "6XXXXXXXX",
  "amount": 0,
  "email": "user@mail.com",
  "applicationKey": "YOUR_KEY",
  "description": "....",
  "payCurrency": "....",
  "payeeAddress": "...."
}

Endpoint: Crypto Withdraw (Matic)

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Bulk Withdraw

Send money to multiple recipients simultaneously. Ideal for automating payroll or reward campaigns.

How Bulk Mode Works

Instead of calling the API for each person, you send a transactions.

The system first validates that your balance covers the total amount of the batch.
Each transaction is processed asynchronously.
The API returns a bulkOperationId to track overall progress.

Field	Structure	Required
applicationKey	string	YES
transactions	Array<Object>	YES

Transaction Object Fields

Field	Type	Required	Description
phoneNumber	string	YES	Recipient's phone number
amount	double	YES	Amount to transfer
email	string	NO	Recipient's email
description	string	NO	Transaction description
recieverName	string	NO	Recipient's full name

POST/api/v2/TransactionSecond/mobile/withdraw/bulk

{
  "applicationKey": "YOUR_KEY",
  "transactions": [
    {
      "phoneNumber": "6XXXXXXXX",
      "amount": 0,
      "email": "user1@example.com",
      "description": "...",
      "recieverName": "...."
    }
  ]
}

Limitation : Pour des raisons de performance, nous recommandons de ne pas dépasser 100 transactions par lot (Bulk).

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Bulk Withdraw Status

Use this endpoint to track the progress of a bulk operation. You will get a global summary as well as the individual status of each transaction.

Understanding Statuses

PENDING : The batch is being processed by operators (MTN/Orange).

COMPLETED : All transactions in the batch have been finalized (Success or Failure).

PARTIAL : Some transactions have failed (e.g., insufficient balance or invalid number).

URL Parameters

URL Parameter	Type	Required	Description
bulkOperationId	string	YES	The ID returned when the bulk operation was created

Response Fields

Field	Type	Required	Description
bulkOperationId	string	Yes	Unique batch identifier
totalCount	int	Yes	Total transactions in batch
successCount	int	Yes	Number of successful transactions
failedCount	int	Yes	Number of failed transactions
pendingCount	int	Yes	Number of transactions still processing
status	string	Yes	Overall batch status (Pending, Completed, Partial)
createdAt	datetime	Yes	Creation date
updatedAt	datetime	Yes	Last update date

Transaction Object Fields

Field	Type	Required	Description
id	string	Yes	Unique transaction ID
phoneNumber	string	Yes	Recipient phone number
amount	double	Yes	Transaction amount
email	string	Yes	Recipient email
description	string	Yes	Internal description
status	string	Yes	Individual transaction status
transactionKey	string	Yes	External bank/operator reference key
errorMessage	string	Yes	Error details if failed
createdAt	datetime	Yes	Timestamp

GET/api/v2/TransactionSecond/mobile/widraw/bulk/{bulkOperationId}

JSON Response Example

{
  "bulkOperationId": "BK-2026-X99",
  "totalCount": 2,
  "successCount": 1,
  "failedCount": 1,
  "pendingCount": 0,
  "status": "Completed",
  "createdAt": "2026-06-05T09:59:22.660Z",
  "updatedAt": "2026-06-05T09:59:22.660Z",
  "transactions": [
    {
      "id": "uuid-123",
      "phoneNumber": "6XXXXXXXX",
      "amount": 5000,
      "email": "user@example.com",
      "description": "Payment",
      "status": "Success",
      "transactionKey": "KEY123",
      "errorMessage": "",
      "createdAt": "2026-06-05T09:59:22.660Z"
    }
  ]
}

Pro Tip: Don't poll this endpoint too quickly. We recommend an interval of 5 to 10 seconds between each status check to optimize your performance.

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Standard Verification

Check the status of a Mobile Money or Bank payment. This endpoint queries the final status directly from the concerned operator.

When to call this endpoint?

If you haven't received the confirmation Webhook.
When a customer returns to your SuccessUrl to validate their purchase.
To resolve doubt about a pending transaction.

URL Parameters

URL Parameter	Type	Required
transactionkey	string	YES

Response Fields

Field	Type	Required	Description
transactionReference	string	Yes	Unique reference for the transaction
transactionAmount	double	Yes	Amount to be paid
transactionDescription	string	Yes	Short summary of the purchase
walletToken	string	Yes	Internal token for wallet referencing
transactionType	string	Yes	Type of transaction (Payment, etc.)
transactionCategory	string	Yes	Category of the transaction
successUrl	string	Yes	URL to redirect on success
cancelUrl	string	Yes	URL to redirect on cancellation
transactionKey	string	Yes	Unique technical identifier
productName	string	No	Name of the product purchased
transactionStatus	string	Yes	Current status (SUCCESS, FAILED, PENDING)
paymentUrl	string	Yes	Link to the payment gateway
raison	string	No	Detailed reason in case of failure
cryptoPayAmount	double	No	Amount in cryptocurrency (if applicable)
paymentAddress	string	No	Sender crypto address
payeeAddress	string	No	Recipient crypto address
ash	string	No	Transaction hash on the blockchain
createdAt	datetime	Yes	Transaction creation date

Customer Details (Contact)

Field	Type	Required	Description
id	string	Yes	Contact unique identifier
phoneNumber	string	Yes	Customer's mobile number
email	string	Yes	Customer's email address
address	string	No	Physical address
city	string	No	Customer's city
state	string	No	State or region
country	string	No	Customer's country
zipCode	string	No	Postal code

History (Inner Transactions)

Field	Type	Required	Description
id	string	Yes	Transaction unique identifier
transactionType	string	Yes	Type of transaction
transactionStatus	string	Yes	Status of the individual transaction
operator	string	Yes	Operator used (MTN, Orange, etc.)
transactionAmount	double	Yes	Total amount
transactionWithOutFees	double	Yes	Net amount without fees
transactionReference	string	Yes	Merchant reference
transactionKey	string	Yes	Technical key
transactionDescription	string	Yes	Description
paymentUrl	string	No	Payment link
faildRaison	string	No	Failure details
ash	string	No	Blockchain hash
createdAt	datetime	Yes	Timestamp

GET/api/v2/TransactionSecond/verify/{transactionkey}/{ash}

Response Body

{
  "transactionReference": "string",
  "transactionAmount": 0,
  "transactionDescription": "string",
  "walletToken": "string",
  "transactionType": "string",
  "transactionCategory": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "transactionKey": "string",
  "productName": "string",
  "transactionContact": {
    "id": "string",
    "address": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "phoneNumber": "string",
    "email": "string",
    "transactions": [
      {
        "id": "string",
        "transactionType": 0,
        "transactionStatus": 0,
        "operator": 0,
        "transactionAmount": 0,
        "transactionWithOutFees": 0,
        "transactionReference": "string",
        "transactionKey": "string",
        "walletToken": "string",
        "transactionDescription": "string",
        "successUrl": "string",
        "cancelUrl": "string",
        "productName": "string",
        "paymentUrl": "string",
        "faildRaison": "string",
        "description": "string",
        "payCurrency": "string",
        "payAmount": 0,
        "ash": "string",
        "transactionContactId": "string",
        "transactionCategory": 0,
        "transactionContact": "string",
        "paymentAddress": "string",
        "realAmount": 0,
        "payeeAddress": "string",
        "businnesId": "string",
        "business": {
          "id": "string",
          "name": "string",
          "description": "string",
          "returnUrl": "string",
          "callbackUrl": "string",
          "logoUrl": "string",
          "allowIp": "string",
          "balance": 0,
          "activateEmail": true,
          "prevWidrawAmount": 0,
          "transactionFees": 0,
          "userId": "string",
          "user": {
            "id": "string",
            "userName": "string",
            "normalizedUserName": "string",
            "email": "string",
            "normalizedEmail": "string",
            "emailConfirmed": true,
            "passwordHash": "string",
            "securityStamp": "string",
            "concurrencyStamp": "string",
            "phoneNumber": "string",
            "phoneNumberConfirmed": true,
            "twoFactorEnabled": true,
            "lockoutEnd": "2026-06-05T10:17:07.235Z",
            "lockoutEnabled": true,
            "accessFailedCount": 0,
            "fullName": "string",
            "enterpriseName": "string",
            "websiteUrl": "string",
            "status": 0,
            "logoName": "string",
            "nuiValue": "string",
            "type": 0,
            "cardId": "string",
            "card": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "niuId": "string",
            "niu": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "commercialRegisterId": "string",
            "commercialRegister": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "taxSheetId": "string",
            "taxSheet": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "ribId": "string",
            "rib": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "widrawCountTransaction": 0,
            "createdAt": "2026-06-05T10:17:07.236Z",
            "updatedAt": "2026-06-05T10:17:07.236Z"
          },
          "businessOperatorBalance": [
            {
              "id": "string",
              "businessId": "string",
              "operator": 0,
              "amount": 0,
              "createdAt": "2026-06-05T10:17:07.236Z",
              "updatedAt": "2026-06-05T10:17:07.236Z"
            }
          ],
          "createdAt": "2026-06-05T10:17:07.236Z",
          "updatedAt": "2026-06-05T10:17:07.236Z"
        },
        "createdAt": "2026-06-05T10:17:07.236Z",
        "updatedAt": "2026-06-05T10:17:07.236Z",
        "bulkOperationId": "string"
      }
    ]
  },
  "transactionStatus": "string",
  "paymentUrl": "string",
  "raison": "string",
  "cryptoPayAmount": 0,
  "paymentAddress": "string",
  "payeeAddress": "string",
  "ash": "string",
  "createdAt": "2026-06-05T10:17:07.236Z"
}

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

Crypto Verification

Verify the status of a completed or pending crypto transaction.

IMPORTANT

The parameter ash corresponds to the Transaction ash (TXID) generated by the network. Without this ash, verification cannot be completed.

URL Parameters

URL Parameter	Type	Required
transactionkey	string	YES
ash	string	YES

Response Fields

Field	Type	Required	Description
transactionReference	string	Yes	Unique reference for the transaction
transactionAmount	double	Yes	Amount to be paid
transactionDescription	string	Yes	Short summary of the purchase
walletToken	string	Yes	Internal token for wallet referencing
transactionType	string	Yes	Type of transaction
transactionCategory	string	Yes	Category of the transaction
successUrl	string	Yes	URL to redirect on success
cancelUrl	string	Yes	URL to redirect on cancellation
transactionKey	string	Yes	Unique technical identifier
productName	string	No	Name of the product purchased
transactionStatus	string	Yes	Current status (SUCCESS, FAILED, PENDING)
paymentUrl	string	Yes	Link to the payment gateway
raison	string	No	Detailed reason in case of failure
cryptoPayAmount	double	No	Amount in cryptocurrency
paymentAddress	string	No	Sender crypto address
payeeAddress	string	No	Recipient crypto address
ash	string	No	Transaction hash on the blockchain
createdAt	datetime	Yes	Transaction creation date

Customer Details (Contact)

Field	Type	Required	Description
id	string	Yes	Contact unique identifier
phoneNumber	string	Yes	Customer's mobile number
email	string	Yes	Customer's email address
address	string	No	Physical address
city	string	No	Customer's city
state	string	No	State or region
country	string	No	Customer's country
zipCode	string	No	Postal code

History (Inner Transactions)

Field	Type	Required	Description
id	string	Yes	Transaction unique identifier
transactionType	string	Yes	Type of transaction
transactionStatus	string	Yes	Status of the individual transaction
operator	string	Yes	Operator used (MTN, Orange, etc.)
transactionAmount	double	Yes	Total amount
transactionWithOutFees	double	Yes	Net amount without fees
transactionReference	string	Yes	Merchant reference
transactionKey	string	Yes	Technical key
transactionDescription	string	Yes	Description
paymentUrl	string	No	Payment link
faildRaison	string	No	Failure details
ash	string	No	Blockchain hash
createdAt	datetime	Yes	Timestamp

GET/api/v2/TransactionSecond/verify/{transactionkey}/{ash}

Response Body

{
  "transactionReference": "string",
  "transactionAmount": 0,
  "transactionDescription": "string",
  "walletToken": "string",
  "transactionType": "string",
  "transactionCategory": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "transactionKey": "string",
  "productName": "string",
  "transactionContact": {
    "id": "string",
    "address": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string",
    "phoneNumber": "string",
    "email": "string",
    "transactions": [
      {
        "id": "string",
        "transactionType": 0,
        "transactionStatus": 0,
        "operator": 0,
        "transactionAmount": 0,
        "transactionWithOutFees": 0,
        "transactionReference": "string",
        "transactionKey": "string",
        "walletToken": "string",
        "transactionDescription": "string",
        "successUrl": "string",
        "cancelUrl": "string",
        "productName": "string",
        "paymentUrl": "string",
        "faildRaison": "string",
        "description": "string",
        "payCurrency": "string",
        "payAmount": 0,
        "ash": "string",
        "transactionContactId": "string",
        "transactionCategory": 0,
        "transactionContact": "string",
        "paymentAddress": "string",
        "realAmount": 0,
        "payeeAddress": "string",
        "businnesId": "string",
        "business": {
          "id": "string",
          "name": "string",
          "description": "string",
          "returnUrl": "string",
          "callbackUrl": "string",
          "logoUrl": "string",
          "allowIp": "string",
          "balance": 0,
          "activateEmail": true,
          "prevWidrawAmount": 0,
          "transactionFees": 0,
          "userId": "string",
          "user": {
            "id": "string",
            "userName": "string",
            "normalizedUserName": "string",
            "email": "string",
            "normalizedEmail": "string",
            "emailConfirmed": true,
            "passwordHash": "string",
            "securityStamp": "string",
            "concurrencyStamp": "string",
            "phoneNumber": "string",
            "phoneNumberConfirmed": true,
            "twoFactorEnabled": true,
            "lockoutEnd": "2026-06-05T10:29:52.518Z",
            "lockoutEnabled": true,
            "accessFailedCount": 0,
            "fullName": "string",
            "enterpriseName": "string",
            "websiteUrl": "string",
            "status": 0,
            "logoName": "string",
            "nuiValue": "string",
            "type": 0,
            "cardId": "string",
            "card": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "niuId": "string",
            "niu": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "commercialRegisterId": "string",
            "commercialRegister": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "taxSheetId": "string",
            "taxSheet": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "ribId": "string",
            "rib": {
              "id": "string",
              "fileName": "string",
              "custumFileName": "string"
            },
            "widrawCountTransaction": 0,
            "createdAt": "2026-06-05T10:29:52.518Z",
            "updatedAt": "2026-06-05T10:29:52.518Z"
          },
          "businessOperatorBalance": [
            {
              "id": "string",
              "businessId": "string",
              "operator": 0,
              "amount": 0,
              "createdAt": "2026-06-05T10:29:52.518Z",
              "updatedAt": "2026-06-05T10:29:52.518Z"
            }
          ],
          "createdAt": "2026-06-05T10:29:52.518Z",
          "updatedAt": "2026-06-05T10:29:52.518Z"
        },
        "createdAt": "2026-06-05T10:29:52.518Z",
        "updatedAt": "2026-06-05T10:29:52.518Z",
        "bulkOperationId": "string"
      }
    ]
  },
  "transactionStatus": "string",
  "paymentUrl": "string",
  "raison": "string",
  "cryptoPayAmount": 0,
  "paymentAddress": "string",
  "payeeAddress": "string",
  "ash": "string",
  "createdAt": "2026-06-05T10:29:52.518Z"
}

Remember to include your accessToken in the Header of this request (Authorization: Bearer [token]). It is essential for security.

MANAGE YOUR PAYMENTS

API Key Management

Application Key (Public)

Secret Key (Private / Signature)

Access Token (Temporary JWT)

Important Recovery Note

Authentication & Security

The signature is calculated as follows:

Success Response (200 OK)

Token Usage (Bearer Auth)

Key Protection

Mobile Payment

How Mobile Money payments work

Payment Workflow

Bank Payment

Bank Payment Process

Bank Workflow

Crypto Payment (USDT)

How Crypto Flow Works

Web3 / Crypto Workflow

Mobile Withdraw

How withdrawal works

Withdrawal Workflow

Withdrawal (Crypto & USDT)

Specificity

Bulk Withdraw

How Bulk Mode Works

Bulk Withdraw Status

Understanding Statuses

Standard Verification

When to call this endpoint?

Crypto Verification

IMPORTANT

MANAGE YOUR PAYMENTS

API Key Management

Application Key (Public)

Secret Key (Private / Signature)

Access Token (Temporary JWT)

Important Recovery Note

Authentication & Security

The signature is calculated as follows:

Success Response (200 OK)

Token Usage (Bearer Auth)

Key Protection

Mobile Payment

How Mobile Money payments work

Payment Workflow

Bank Payment

Bank Payment Process

Bank Workflow

Crypto Payment (USDT)

How Crypto Flow Works

Web3 / Crypto Workflow

Mobile Withdraw

How withdrawal works

Withdrawal Workflow

Withdrawal (Crypto & USDT)

Specificity

Bulk Withdraw

How Bulk Mode Works

Bulk Withdraw Status

Understanding Statuses

Standard Verification

When to call this endpoint?

Crypto Verification

IMPORTANT

MANAGE YOUR
PAYMENTS

MANAGE YOUR
PAYMENTS