🏧 Payout API

The Payout API allows merchants to programmatically request payouts from their Malum account. With this API, you can automate the process of transferring funds to designated crypto wallet.

By integrating the Payout API into your system, you can manage payout requests efficiently, ensuring timely disbursements without the need for manual intervention. This API is designed to enhance your control over fund transfers, whether you need to process individual payments or batch payouts.

Key Features:

• Automated Payout Requests: Submit payout requests directly from your application.

• Secure Transactions: Ensure your financial data and payouts are protected with robust security measures.

• Flexible Payout Options: Transfer funds to bank accounts, payment gateways, or other supported methods.

Ideal for merchants looking to optimize and automate their payout processes.

Endpoint

POST https://malum.co/api/v3/account/payout

Headers

To authenticate your request, use the following header structure:

MALUM: {Business ID}:{Secret Key}

• Business ID: Your unique Malum account identifier.

• Secret Key: Your API secret key for secure access.

POST Content (JSON)

{
  "amount": 1.01, // Min Amount 1.01 USD
  "currency": "BTC", // The currency in which you want to receive the payout
  "network": "BTC", // The network of the chosen currency
  "address": "your crypto address" // The cryptocurrency address to which funds will be sent
}

Fields:

• amount: The payout amount in USD. The minimum amount is 1.01 USD.

• currency: The cryptocurrency in which you want to receive the payout (e.g., "BTC").

• network: The network of the chosen cryptocurrency (e.g., "BTC" for Bitcoin).

• address: The cryptocurrency address to which the funds will be sent.

Success Response

When the payout request is successful, the API will return the following JSON structure:

{
    "status": "success",
    "message": "Withdrawal of 1.00 USD to LXrXXXXXXXdGEkUWsXXXXXXXX initiated.",
    "data": {
        "order_id": "PO_67XXX8e1XXXXX"
    },
    "timestamp": 1728679453
}

• status: Indicates the success of the payout request.

• message: A descriptive message detailing the transaction and the amount sent.

• data:

  • order_id: A unique identifier for the initiated payout order.

• timestamp: Unix timestamp indicating when the payout was initiated.

Error Response

In case of failure, the API will return an error in the following format:

{
    "status": "failed",
    "error": "Amount is invalid. Amount must be larger than 1.00 USD",
    "timestamp": 1728679483
}

• status: Error status message indicating the failure.

• error: A descriptive error message explaining the issue (e.g., invalid amount).

• timestamp: Unix timestamp indicating when the error occurred.

Example Request

curl --location --request POST 'https://malum.co/api/v3/account/payout' \
--header 'MALUM: yourBusinessID:yourSecretKey' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 1.01,
    "currency": "BTC",
    "network": "BTC",
    "address": "yourCryptoAddress"
}'

Example Success Response

{
    "status": "success",
    "message": "Withdrawal of 1.00 USD to LXrXXXXXXXdGEkUWsXXXXXXXX initiated.",
    "data": {
        "order_id": "PO_67XXX8e1XXXXX"
    },
    "timestamp": 1728679453
}

Example Error Response

{
    "status": "failed",
    "error": "Amount is invalid. Amount must be larger than 1.00 USD",
    "timestamp": 1728679483
}

Notes and Fees

• Irreversible Transactions: Once a transaction has been initiated, it cannot be undone or reversed. Ensure that you provide the correct details, including the amount, currency, network, and wallet address.

• Secure Your API Keys: Withdrawn funds are not under Malum's control once processed. Ensure your API keys are secure to prevent unauthorized payouts.

• Payouts requested via API are subject to an additional 1% service fee + network fees.