Skip to main content

Add Fund

The Add Fund API is designed to increase the fund balance for a specific business unit of a supplier organization. This endpoint allows users to add credits to the fund balance, facilitating financial management and budgeting for campaigns.

  • Method: POST

  • URL: https://<PA_RM_END_POINT>/rm/1.0/fund/{businessUnitId}

    info

    Refer to the Supplier API documentation for detailed instructions on how to retrieve the businessUnitId.

  • Headers:

    • Content-Type: application/json
    • Authorization: Bearer ACCESS_TOKEN
  • Request Body:

    {
    "amount": 500.00
    }
    • amount (float): The amount of funds to be added to the business unit's fund balance.
  • Response Codes:

    • 200 OK

      Successful addition of funds. The response body will include the updated fund balance:

      {
      "payload": {
      "id": "xxxxxxxxxxxxxxxxxxxxxxx",
      "credits": 1500.00,
      "spent": 800.00
      }
      }
      • id (GUID): The unique identifier for the fund.

      • credits (float): Updated total amount that has been added to the fund.

      • spent (float): Total amount that has been spent from the fund.

      info

      The available fund balance after the update will be the difference between the credits and spent amounts.

    • Non-200 Responses

      If an error occurs (e.g., bad request, unauthorized access, insufficient permissions, or business unit not found), the server will respond with an appropriate non-200 status code and include an error message in the response body:

      {
      "error": "Error message"
      }