Instant Funding

Instant Funding API Documentation

Overview

The Instant Funding service provides merchants with immediate access to funds from their transactions, enhancing liquidity and improving cash flow management. By streamlining the payment process, merchants can receive funds promptly, improving their financial flexibility and operational efficiency.

Key Business Benefits

  1. Improved Cash Flow: Merchants can meet financial obligations quickly, invest in new opportunities, and manage revenue fluctuations.
  2. Enhanced Customer Experience: Faster access to funds leads to increased merchant satisfaction and loyalty.
  3. Competitive Edge: Offering Instant Funding differentiates the Finance CRM system by prioritizing merchant convenience.
  4. Increased Transaction Volume: Instant access to funds encourages merchants to process more transactions, boosting overall revenue.

API Endpoints

1. Verify Instant Funding Availability

Endpoint:
POST /Transfers/Verify

Description:
This method verifies the available amount for instant funding based on the merchant's transaction batch. Merchants should use this endpoint to check how much they can withdraw instantly before proceeding with a transfer.

Request Body Parameters:

{
  "mid": 0,
  "amount": 0
}
  • mid (integer) – The unique identifier of the merchant.
  • amount (decimal) – The total transaction batch amount for which the merchant wants to verify instant funding availability.

Response:

{
  "status": "success",
  "availableAmount": 0
}
  • status (string) – Status of the verification request (e.g., "success", "error").
  • availableAmount (decimal) – The maximum amount eligible for instant funding.

2. Confirm and Transfer Funds

Endpoint:
POST /Transfers

Description:
This method confirms the requested instant funding amount and transfers the funds to the merchant’s bank account. Merchants should use this endpoint after verifying the available amount with the previous method.

Request Body Parameters:

{
  "mid": 0,
  "amount": 0
}
  • mid (integer) – The unique identifier of the merchant.
  • amount (decimal) – The amount the merchant wants to transfer, which should not exceed the availableAmount from the verification step.

Response:

{
  "status": "success",
  "transferID": "string",
  "transferredAmount": 0
}
  • status (string) – Status of the transfer request (e.g., "success", "error").
  • transferID (string) – A unique identifier for the completed transfer.
  • transferredAmount (decimal) – The amount that was successfully transferred to the merchant’s bank account.

Usage Workflow

  1. Step 1: Call POST /Transfers/Verify with the merchant ID and batch amount to check the available amount for instant funding.
  2. Step 2: Once the available amount is returned, use POST /Transfers with the confirmed amount to transfer the funds.
  3. Step 3: Upon successful transfer, the response will include a transferID for reference and confirmation.

Error Handling

Common Errors

Error CodeDescriptionResolution
400Invalid request parametersEnsure that all required fields are correctly provided and properly formatted.
404Merchant not foundVerify that the merchantID is correct and exists in the system.
422Requested amount exceeds available amountEnsure the requested amount does not exceed the availableAmount.
500Internal server errorRetry the request. If the issue persists, contact technical support.


Security

  • All requests must be authenticated using an API key. The key should be included in the request header:
    Authorization: Basic <API_KEY>
  • Ensure all requests are made over HTTPS to maintain data security.

Contact Support

For any issues or questions regarding the Instant Funding API, please contact our support team at devsupport@netevia.com.