Skip to main content

Finance API

Overview​

This page covers the methods and endpoints associated with finance operations. With the Finance API you can access finance details and lists, and manage invoices, credit, and payment.

Authentication​

Use the following header parameters for all requests:

Headers
Authentication
string required		Authentication bearer token
See Authentication Guide
X-IAA-OW-ID
integer required		Organization Worskpace ID Header

Finance Details​

Get Customer Finance Details​

GET /api/v3/fa/customer/financial-details

Get an overview of a customer's finance details.

Query Parameters
owId
integer		Organization Workspace ID
isFinanceRequest
boolean		Represents whether request came from finance tab in customer app
For Customer Management Tab: false
For Finance Tab: true
year
integer		Year for data
Resource Properties
pendingCampaigns
integer		Number of Campaigns in pending status (see Campaign API for more info on statuses)
runningCampaigns
integer		Number of Campaigns in running status (see Campaign API for more info on statuses)
totalCampaigns
integer		Total number of Campaigns associated with customer
dataCost
integer		Data cost applied on Campaigns of a given customer
actualSpent
integer		Amount of media spending by customer
credits
integer		Customer credits
balance
integer		Funds balance of customer
spent
integer		Total Campaign spending (media and data) by customer
earning
integer		Earnings made by organization
Response 200
{
    "success": true,
    "data": {
        "pendingCampaigns": 15,
        "runningCampaigns": 10,
        "totalCampaigns": 48,
        "dataCost": 0,
        "actualSpent": 0,
        "credits": 0,
        "balance": 30430.75,
        "spent": 0,
        "earning": 0
    }
}

Get List of Payment Transactions for Organization​

GET /api/v3/fa/payments/list

Get a list of payment transactions for an organization.

Query Parameters
status
string		Status ID
See Static Details List for supported values
paymentType
string		Payment type ID
See Static Details List for supported values
searchField
string		Search results by keyword
limit
integer		Maximum number of entries returned, default: 10
pageNo
integer		Page number for the data, default: 1
Resource Properties
isPaymentInitiatorOrg
boolean		Indicates whether payment was created by logged-in organization (true) or not (false)
paymentId
integer		Payment ID
createdByUserEmail
string		Email of user who created payment
paymentDate
integer		Unix epoch timestamp of payment date, in milliseconds
paymentAmount
integer		Payment amount
paymentStatus
string		Payment Status
paymentMode
string		Payment Mode
paymentType
string		Payment Type
invoiceId
integer		Invoice ID
modifiedAt
integer		Unix epoch timestamp of modification date, in milliseconds
bankName
string		Bank associated with payment, if applicable, otherwise: null
refundReason
string		Reason for refund, if applicable, otherwise: null
Response 200
{
    "success": true,
    "data": {
        "data": [
            {
                "isPaymentInitiatorOrg": true,
                "paymentId": 19,
                "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com",
                "paymentDate": 1632076200000,
                "paymentAmount": 10000,
                "paymentStatus": "Rejected",
                "paymentMode": "PayPal",
                "paymentType": "As Fund",
                "invoiceId": 0,
                "modifiedAt": 1637566978000,
                "bankName": null,
                "refundReason": null
            },
            {
                "isPaymentInitiatorOrg": false,
                "paymentId": 886,
                "createdByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "paymentDate": 1635791400000,
                "paymentAmount": 10,
                "paymentStatus": "Processing",
                "paymentMode": "Check",
                "paymentType": "Refund",
                "invoiceId": 0,
                "modifiedAt": 1635831910000,
                "bankName": null,
                "refundReason": "Testing"
            },
            {
                "isPaymentInitiatorOrg": false,
                "paymentId": 885,
                "createdByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "paymentDate": 1635791400000,
                "paymentAmount": 10,
                "paymentStatus": "Processing",
                "paymentMode": "To Funds",
                "paymentType": "Refund",
                "invoiceId": 0,
                "modifiedAt": 1635831695000,
                "bankName": null,
                "refundReason": "Testing"
            },
            {
                "isPaymentInitiatorOrg": false,
                "paymentId": 884,
                "createdByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "paymentDate": 1635791400000,
                "paymentAmount": 10,
                "paymentStatus": "Processing",
                "paymentMode": "To Funds",
                "paymentType": "Refund",
                "invoiceId": 0,
                "modifiedAt": 1635831127000,
                "bankName": null,
                "refundReason": "Testing"
            },
            {
                "isPaymentInitiatorOrg": false,
                "paymentId": 883,
                "createdByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "paymentDate": 1635791400000,
                "paymentAmount": 10,
                "paymentStatus": "Processing",
                "paymentMode": "To Funds",
                "paymentType": "Refund",
                "invoiceId": 0,
                "modifiedAt": 1635830983000,
                "bankName": null,
                "refundReason": "Testing"
            }
        ],
        "totalRecords": 68,
        "filteredRecords": 68
    }
}

Get List of Customer Payments​

GET /api/v3/fa/customer/payments/list

Get a list of payments by customer.

Query Parameters
owId
integer		Organization Workspace ID
status
string		Status type
paymentType
string		Payment Type
searchField
string		Search results by keyword
limit
integer		Maximum number of entries returned, default: 10
pageNo
integer		Page number for the data, default: 1
sortBy
string		Sorts by ascending (+) or descending (-), default: -modifiedAt
Supported values: paymentId, paymentDate, paymentAmount, organizationName, paymentType, paymentMode, paymentStatus
Response 200
{
    "success": true,
    "data": {
        "data": [
            {
                "isPaymentInitiatorOrg": false,
                "paymentId": 19,
                "createdAt": 1632295016000,
                "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com",
                "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "paymentDate": 1632076200000,
                "paymentAmount": 10000,
                "paymentStatus": "Rejected",
                "paymentMode": "PayPal",
                "paymentType": "As Fund",
                "invoiceId": 0,
                "transactionId": "T-1234567",
                "modifiedAt": 1637566978000,
                "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "bankName": null,
                "refundReason": null
            },
            {
                "isPaymentInitiatorOrg": false,
                "paymentId": 886,
                "createdAt": 1635831910000,
                "createdByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "paymentDate": 1635791400000,
                "paymentAmount": 10,
                "paymentStatus": "Processing",
                "paymentMode": "Check",
                "paymentType": "Refund",
                "invoiceId": 0,
                "transactionId": "123456",
                "modifiedAt": 1635831910000,
                "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "bankName": null,
                "refundReason": "Testing"
            },
            {
                "isPaymentInitiatorOrg": false,
                "paymentId": 885,
                "createdAt": 1635831695000,
                "createdByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "paymentDate": 1635791400000,
                "paymentAmount": 10,
                "paymentStatus": "Processing",
                "paymentMode": "To Funds",
                "paymentType": "Refund",
                "invoiceId": 0,
                "transactionId": "123456",
                "modifiedAt": 1635831695000,
                "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "bankName": null,
                "refundReason": "Testing"
            },
            {
                "isPaymentInitiatorOrg": false,
                "paymentId": 884,
                "createdAt": 1635831127000,
                "createdByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "paymentDate": 1635791400000,
                "paymentAmount": 10,
                "paymentStatus": "Processing",
                "paymentMode": "To Funds",
                "paymentType": "Refund",
                "invoiceId": 0,
                "transactionId": "123456",
                "modifiedAt": 1635831127000,
                "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "bankName": null,
                "refundReason": "Testing"
            },
            {
                "isPaymentInitiatorOrg": false,
                "paymentId": 883,
                "createdAt": 1635830983000,
                "createdByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "paymentDate": 1635791400000,
                "paymentAmount": 10,
                "paymentStatus": "Processing",
                "paymentMode": "To Funds",
                "paymentType": "Refund",
                "invoiceId": 0,
                "transactionId": null,
                "modifiedAt": 1635830983000,
                "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com",
                "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg",
                "bankName": null,
                "refundReason": "Testing"
            }
        ],
        "totalRecords": 68,
        "filteredRecords": 68
    }
}

Get Invoice for Organization​

GET /api/v3/fa/invoice-settings

Get an invoice for an organization.

Resource Properties
invoiceId
integer		Invoice ID
owId
integer		Organization Workspace ID
invoiceTitle
string		Invoice title
invoiceCompanyName
string		Company name associated with invoice
invoiceCompanyAddress
string		Address associated with company
email
string		Company email
website
string		Company website
invoiceDescription
string		Invoice description
paypalId
integer		PayPal ID
chequeTransferId
integer		Cheque transfer ID
wireTransferId
integer		Wire transfer ID
termsAndConditions
string		Terms and conditions of invoice
paymentTerm
string		Payment term of invoice
invoiceFooter
string		Invoice footer details
createdAt
string		Creation date of invoice
Response 200
{
    "success": true,
    "data": {
        "invoiceId": 1,
        "owId": 334,
        "invoiceTitle": "The Alchemist",
        "invoiceCompanyName": "The Alchemist",
        "invoiceCompanyAddress": "42, 6th Avenue, New York, NY",
        "email": "shraddha.p+alchemist@iqm.com",
        "website": "www.alchemist.com",
        "invoiceDescription": "Dear Customer, Greetings from The Alchemist, we are writing to provide you an electronic invoice for your use of services.",
        "paypalId": 1,
        "chequeTransferId": 1,
        "wireTransferId": 2,
        "termsAndConditions": "Please make the payment in 30 days or your account might be put on hold",
        "paymentTerm": "30",
        "invoiceFooter": "The Alchemist | 12.234.56.789 | USA",
        "createdAt": "2021-08-27T07:33:14.000+00:00"
    }
}

Get Invoice Payment Details​

GET /api/v3/fa/invoice-settings-payment-details

Get invoice payment details by invoice ID.

Query Parameters
invoiceId
integer		Invoice ID
Response 200
{
    "success": true,
    "data": {
        "paypalPaymentDetail": {
            "paypalId": 1,
            "paypalAccountId": "thealchemistfinance@paypal"
        },
        "chequePaymentDetail": {
            "chequeId": 1,
            "chequeCompanyName": "The Alchemist Company",
            "chequeCompanyAddress": "45, Fifth Avenue, NY, USA"
        },
        "wireTransferPaymentDetail": {
            "wireTransferId": 2,
            "wireTransferCompanyName": "The Alchemist",
            "bankName": "JP Morgan Chase Bank",
            "accountNumber": "670669295",
            "bankAddress": "498 7th Avenue New York NY",
            "swiftCode": "MGTCUS3G",
            "routing": "150098"
        }
    }
}

Get List of Invoices for Customer or Organization​

GET /api/v3/fa/invoice/list/{owId}

Get a list of invoices by customer or organization.

Path Parameters
owId
integer		Organization Workspace ID
Query Parameters
status
string		Status ID
See Static Details List for supported values
sortBy
string		Sorts by ascending (+) or descending (-), default: -invoiceId
Supported values: issuedOn, invoiceAmount, status
isCustomerRequest
boolean		(Organization endpoint only) Customer app request (default): true
Organization app request: false
Response 200
{
    "success": true,
    "data": {
        "data": [
            {
                "invoiceId": 79,
                "invoiceFromDate": 1601510400,
                "invoiceToDate": 1604102400,
                "issuedOn": 1632182400,
                "invoiceAmount": 553611.718,
                "status": 7,
                "paymentTerm": 30,
                "paidAmount": 5000,
                "paymentMode": [
                    2,
                    4
                ],
                "invoiceName": "Zydus - Oct2020",
                "actionNote": null,
                "invoiceStatusUpdatedBy": "Kartik Gevariya",
                "modifiedAt": 1632801378000
            }
        ],
        "totalRecords": 0,
        "filteredRecords": 0
    }
}

Get Customer Margin Details​

GET /api/v3/fa/customer/view-margin

Get customer margin details by margin type.

Query Parameters
marginTypeIds
string		Comma separated margin type IDs
See static details list for supported values
owId
integer		Organization Workspace ID
Response 200
{
    "success": true,
    "data": {
        "totalRecords": 1,
        "data": [
            {
                "marginTypeId": 1,
                "marginType": "Gross Margin",
                "marginValue": 15
            }
        ],
        "filteredRecords": 1,
        "isBidShadingEnabled": false
    }
}

Update Customer Margin Details​

POST /api/v3/fa/customer/edit-margin
Request Schema
owId
integer		Organization Workspace ID
marginTypeId
integer		Margin type ID
marginValue
integer		Margin value
Request Sample
{
    "owId": 202318,
    "marginTypeId": 1,
    "marginValue": 15
}

Get Customer PG Fees Details​

GET /api/v3/fa/customer/{owId}/pg-fees

Get details for customer PG fees.

Path Parameters
owId
integer		Organization Workspace ID
Response 200
{
    "success": true,
    "data": {
        "organizationPgFeesDetails": {
            "pgCampaignFees": 10,
            "pgWorkspaceShare": 15
        }
    }
}

Edit Customer PG Fees​

PATCH /api/v3/fa/customer/{customerOwId}/pg-fees
Path Parameters
customerOwId
integer		Customer Organization Workspace ID
Request Schema
owId
integer		Organization Workspace ID
pgCampaignFees
integer		PG Campaign Fees
pgWorkspaceShare
integer		The share of PG fees applied to the Campaign by the workspace
Request Sample
{
    "owId": 202318,
    "pgCampaignFees": 10,
    "pgWorkspaceShare": 15
}
Response 200
{
    "success": true,
    "data": "PG Fees details updated Successfully."
}

Get Customer VLD Finance Details​

GET /api/v3/fa/customer/{customerOwId}/vld-fees

Get finance details for customer VLD.

Path Parameters
customerOwId
integer		Customer Organization Workspace ID
Response 200
{
    "success": true,
    "data": {
        "id": 1,
        "vldRate": 3
    }
}
Response 200 (VLD flag)
{
    "success": true,
    "data": {
        "id": 3,
        "owId": 201427,
        "vldRate": 3,
        "vldEnabled": true,
        "vldMarkupType": "Percentage",
        "vldMarkupValue": 10
    }
}

Updates Customer VLD Details​

PATCH /api/v3/fa/customer/vld-fees
Request Schema
owId
integer		OW ID of the customer to update details (required)
vldRate
integer		VLD rate for workspace customer
vldEnabled
boolean		Boolean flag to enable and disable VLD feature for advertiser customer
vldMarkupTypeId
integer		VLD markup type ID to represent markup types absolute or percentage
vldMarkupValue
integer		VLD markup value for advertiser customer
Request Sample
{
    "id": 0,
    "owId": 0,
    "vldRate": 0,
    "vldEnabled": true,
    "vldMarkupType": "string",
    "vldMarkupTypeId": 0,
    "vldMarkupValue": 9999
}
Response 200
{
    "success": true,
    "data": {
        "id": 1,
        "message": "VLD Rate updated successfully. The new rate applies only to newly created VLDs"
    }
}

Get Basic Financial Details​

GET /api/v3/fa/basic/details
Response 200
{
    "success": true,
    "data": {
        "paypalFeesPercentage": 3.5
    }
}

Available Balance​

GET /api/v3/fa/available-balance
Query Parameters
owId
integer		Organization Workspace ID
isCustomerRequest
boolean		Customer app request (default): true
Organization app request: false
Response 200
{
    "success": true,
    "data": 5855904.72
}

Credit Summary​

GET /api/v3/fa/credit-summary/{owId}

Get credit summary by workspace ID.

Path Parameter
owId
integer		Organization Workspace ID
Query Parameters
isCustomerRequest
boolean		Customer app request (default): true
Organization app request: false
Response 200
{
    "success": true,
    "data": {
        "usedCredit": 21875.37,
        "totalCredit": 50000
    }
}

Offered Credits​

GET /api/v3/fa/credits/list

Get a list of offered credits to organization.

Query Parameters
limit
integer		Maximum number of entries returned, default: 50
pageNo
integer		Page number for the data, default: 1
sortBy
string		Sorts by ascending (+) or descending (-), default: -modifiedAt
Response 200
{
    "success": true,
    "data": {
        "data": [
            {
                "creditId": 2,
                "creditAmount": 1000,
                "modifiedAt": "2021-09-08T10:24:32.000+00:00",
                "status": "Unclaimed",
                "organizationName": "JP test org"
            },
            {
                "creditId": 1,
                "creditAmount": 1500,
                "modifiedAt": "2021-09-08T05:46:15.000+00:00",
                "status": "Revoked",
                "organizationName": "JP test org"
            }
        ],
        "totalRecords": 2,
        "filteredRecords": 2
    }
}

Download Invoice​

GET /api/v3/fa/download-invoice/{owId}/{invoiceId}

Download a PDF invoice.

Path Parameter
owId
integer		Organization Workspace ID
invoiceId
integer		Invoice ID
Query Parameters
isCustomerRequest
boolean		Customer app request (default): true
Organization app request: false

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      "Content-Disposition"?: {

        "text/plain": string;
      };
      [name: string]: unknown;
    };
  };
}

function DownloadInvoice(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/fa/download-invoice/{owId}/{invoiceId}',
    params: {
      query: {
        isCustomerRequest: `boolean`,
      },
      path: {
        owId: `number`,
        invoiceId: `number`,
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Download Payment Receipt​

GET /api/v3/fa/payment/download-receipt/{paymentId}

Download a PDF of payment receipt.

Path Parameter
paymentId
integer		Payment ID
Query Parameter
owId
integer		Organization Workspace ID
isCustomerRequest
boolean		Customer app request (default): true
Organization app request: false

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
  };
}

function DownloadPaymentReceiptpdf(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/fa/payment/download-receipt/{paymentId}',
    params: {
      path: {
        paymentId: `number`
      },
      query: {
        owId: `number`,
        isCustomerRequest: `boolean`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Invoice Management​

Update Invoice Settings​

PATCH /api/v3/fa/invoice-settings/{invoiceId}
Query Parameter
isWhiteLabel
boolean		Set by organization, must be set to true for invoice to be updated
Request Schema
invoiceTitle
string		Invoice title
invoiceCompanyAddress
string		Invoice company address
email
string		Email
website
string		Website
invoiceDescription
string		Invoice description
termsAndConditions
string		Terms and conditions of invoice
paymentTerm
string		Payment Term ID
invoiceFooter
string		Invoice footer details
paypalAcountId
string		PayPal account ID
chequeCompanyName
string		Company name on check (when Payment Mode Type is check)
chequeCompanyAddress
string		Company address on check (when Payment Mode Type is check)
wireTransferCompanyName
string		Company name for wire transfer (when Payment Mode Type is wire transfer)
bankName
string		Bank name
accountNumber
string		Account number
bankAddress
string		Bank address
companyTaxId
string		Company tax ID
companyTaxName
string		Company tax name
Request Sample
{
  "invoiceTitle": "The Alchemist",
  "invoiceCompanyAddress": "42, 6th Avenue, New York, NY",
  "email": "shraddha.p+alchemist@iqm.com",
  "website": "www.alchemist.com",
  "invoiceDescription": "Dear Customer, Greetings from The Alchemist, we are writing to provide you an electronic invoice for your use of services.",
  "termsAndConditions": "Please make the payment in 30 days or your account might be put on hold",
  "paymentTerm": "30",
  "invoiceFooter": "The Alchemist | 12.234.56.789 | USA",
  "paypalAccountId": "thealchemistfinance@paypal",
  "chequeCompanyName": "The Alchemist Company",
  "chequeCompanyAddress": "45, Fifth Avenue, NY, USA",
  "wireTransferCompanyName": "The Alchemist",
  "bankName": "JP Morgan Chase Bank",
  "accountNumber": "670669295",
  "bankAddress": "498 7th Avenue New York NY",
  "companyTaxId": "202130INGST",
  "companyTaxName": "GSTIN"
}
Response 200
{
  "success": true,
  "data": {
    "invoiceId": 1,
    "message": "Invoice details updated successfully"
  }
}
More Responses
Response 422
{
  "success": false,
  "errorObjects": [
    {
      "error": "Invoice does not belong to the logged in organization workspace"
    }
  ]
}
Response
{
  "success": false,
  "errorObjects": [
    {
      "error": "Invoice with the provided ID does not exists"
    }
  ]
}

Delete Invoice Tax Data​

DELETE /api/v3/fa/invoice-settings-tax-data
Query Parameters
taxId
integer		Tax ID
Response 200
{
  "success": true,
  "data": "Tax data deleted successfully"
}
Response 422
{
  "success": false,
  "errorObjects": [
    {
      "error": "Tax ID is invalid"
    }
  ]
}

Approve Invoice​

PATCH /api/v3/fa/invoice-approve/{invoiceId}

Update Invoice Status.

Path Parameter
invoiceId
integer		Invoice ID
Response 200
{
    "success": true,
    "data": "Invoice with the provided ID approved successfully"
}

Cancel Invoice​

PATCH /api/v3/fa/invoice-cancel/{invoiceId}
Response 200
{
    "actionNote": "cancelling invoice"
}

Mark Invoice as Paid​

POST /api/v3/fa/pay-invoice
Request Schema
owId
integer		Organization Workspace ID
paymentAmount
integer		Payment amount
paymentType
integer		Payment type ID
See Static Details List for supported values
invoiceId
integer		Invoice ID
Request Sample
{
    "owId": 678345,
    "paymentAmount": 10000,
    "paymentType": 1,
    "invoiceId": 23
}
Response 200
{
    "success": true,
    "data": "Payment added Successfully."
}

Email Invoice​

POST /api/v3/fa/email-invoice/{owId}/{invoiceId}
Path Parameter
owId
integer		Organization Workspace ID
invoiceId
integer		Invoice ID
Request Schema
email
string		Email to send invoice to
Request Sample
{
    "email": "user@company.com"
}
Response 200
{
    "success": true,
    "data": "Invoice e-mail sent successfully."
}

Credit Management​

Add Credit to Customer​

POST /api/v3/fa/customer/credit/add
Request Schema
owId
integer		Organization Workspace ID
creditAmount
integer		Credit amount to add
Request Sample
{
    "owId": 23,
    "creditAmount": 5000
}
Response 200
{
    "success": true,
    "data": "Credits offered Successfully."
}

Update Credit Offered to Customer​

PATCH /api/v3/fa/customer/credit/edit
Request Schema
owId
integer		Organization Workspace ID
creditAmount
integer		Credit amount to add
creditId
integer		Credit ID
Request Sample
{
    "owId": 54,
    "creditAmount": 4000,
    "creditId": 3
}
Response 200
{
    "success": true,
    "data": "Credits updated Successfully."
}

Revoke Credit Offered to Customer​

POST /api/v3/fa/customer/credit/revoke
Request Schema
owId
integer		Organization Workspace ID
creditId
integer		Credit ID
Request Sample
{
    "owId": 54,
    "creditId": 2
}
Response 200
{
    "success": true,
    "data": "Credits revoked Successfully."
}

Claim Offered Credits​

POST /api/v3/fa/credit/claim
Request Schema
creditId
integer		Credit ID
customerName
string		Customer Name
businessName
string		Business Name
taxId
string		Tax ID
contactPersonName
string		Contact person name
contactPersonEmail
string		Contact person email
incorporationPlace
string		Incorporation location
address
string		Address
Request Sample
{
    "creditId": 4,
    "customerName": "JP test ",
    "businessName": "JP test org3",
    "taxId": "123456",
    "contactPersonName": "JP",
    "contactPersonEmail": "jinesh.p+nonihpcust2@iqm.com",
    "incorporationPlace": "Gujarat, India",
    "address": "A-123, XYZ Complex, Ahmedabad, Gujarat, India - 380059"
}
Response 200
{
    "success": true,
    "data": "Credits claimed."
}

Payment Management​

Add Payment for Customer​

POST /api/v3/fa/customer/payment/add
Request Schema
owId
integer		Organization Workspace ID
paymentAmount
integer		Payment amount
paymentDate
string		Payment date in YYYY-MM-DD format
paymentMode
integer		Payment mode type ID
See Static Details List for supported values
transactionId
integer		Transaction ID
paymentProof
string optional		Proof of payment image (jpeg/png)
paymentType
integer		Payment type ID
See Static Details List for supported values
invoiceId
integer		Invoice ID (provide only if paymentType is Against Invoice)
Request Sample
{
    "owId": 123654,
    "paymentAmount": 5000,
    "paymentDate": "2025-12-01",
    "paymentMode": 1,
    "transactionId": 10,
    "paymentProof": "image.png",
    "paymentType": 2,
    "invoiceId": 34
}
Response 200
{
    "success": true,
    "data": "Payment added Successfully."
}

Edit Customer Payment​

PUT /api/v3/fa/customer/payment/{paymentId}
Path Parameter
paymentId
integer		Payment ID
Response 200
{
    "success": true,
    "data": "Payment updated Successfully."
}

Approve Payment​

Update payment status

POST /api/v3/fa/customer/payment/approve/{paymentId}
Path Parameter
paymentId
integer		Payment ID
Request Schema
owId
integer		Organization Workspace ID
actionNote
string		Description of payment status change
Request Sample
{
    "owId": 200485,
    "actionNote": "Payment paid partially"
}
{
    "success": true,
    "data": "Payment approved Successfully."
}

Cancel Payment​

POST /api/v3/fa/customer/payment/cancel/{paymentId}
Path Parameter
paymentId
integer		Payment ID
Response 200
{
    "success": true,
    "data": "Payment cancelled Successfully."
}

Reject Payment​

POST /api/v3/fa/customer/payment/reject/{paymentId}
Path Parameter
paymentId
integer		Payment ID
Response 200
{
    "success": true,
    "data": "Payment rejected Successfully."
}

Add Payment from Organization App​

POST /api/v3/fa/payment/add-fund
Request Schema
paymentAmount
integer		Payment amount
paymentDate
string		Payment date in YYYY-MM-DD format
paymentMode
integer		Payment mode type ID
See Static Details List for supported values
paymentProof
string optional		Proof of payment image (jpeg/png)
bankName
string		Required only if paymentMode is Check or Wire Transfer
Response 200
{
    "success": true,
    "data": "Payment Successful."
}

Payment with PayPal​

POST /api/v3/fa/paypal/payment
Request Schema
paymentAmount
integer		Payment amount
Response 200
{
    "success": true,
    "data": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-3YM2956846765604B"
}

Initiate Refund​

POST /api/v3/fa/customer/payment/refund
Request Schema
owId
integer		Organization Workspace ID
paymentAmount
integer		Payment amount
paymentDate
string		Payment date in YYYY-MM-DD format
paymentMode
integer		Payment mode type ID
See Static Details List for supported values
transactionId
integer		Transaction ID
paymentProof
string optional		Proof of payment image (jpeg/png)
Response 200
{
    "success": true,
    "data": "Refund Initiated."
}

Approve Refund​

POST /api/v3/fa/customer/payment/approve-refund/{paymentId}
Path Parameter
paymentId
integer		Payment ID
Request Schema
owId
integer		Organization Workspace ID
actionNote
string		Description of status change
Request Sample
{
  "owId": 200485,
  "actionNote": "Payment paid partially"
}
Response 200
{
    "success": true,
    "data": "Refund successful."
}

Email Payment Receipt​

POST /api/v3/fa/payment/email-receipt/{owId}/{paymentId}
Path Parameter
owId
integer		Organization Workspace ID
paymentId
integer		Payment ID
Request Schema
email
string		Email to send receipt to
Request Sample
{
    "email": "example@business.com"
}
Response 200
{
    "success": true,
    "data": "Payment receipt e-mail sent successfully."
}

Static Details Lists​

Payment Types​

GET /api/v3/fa/static/payment-type

Get a list of payment type IDs.

Payment Type IDs
1
As Fund		Payment added into organization balance
2
Against Invoice		Payment used to pay invoice
3
Refund		Payment reversed from platform, deducted from organization's balance and refunded to customer organization
Response 200
{
    "success": true,
    "data": [
        {
            "name": "as_fund",
            "id": 1,
            "label": "As Fund",
            "order": 1
        },
        {
            "name": "against_invoice",
            "id": 2,
            "label": "Against Invoice",
            "order": 2
        },
        {
            "name": "refund",
            "id": 3,
            "label": "Refund",
            "order": 3
        }
    ]
}

Payment Status​

GET /api/v3/fa/static/payment-status

Get a list of payment type IDs.

Properties
1
Processing		Payment in process
2
Paid		Payment paid
3
Rejected		Payment rejected
4
Cancelled		Payment cancelled
Response 200
{
    "success": true,
    "data": [
        {
            "name": "processing",
            "id": 1,
            "label": "Processing",
            "order": 1
        },
        {
            "name": "paid",
            "id": 2,
            "label": "Paid",
            "order": 2
        },
        {
            "name": "rejected",
            "id": 3,
            "label": "Rejected",
            "order": 3
        },
        {
            "name": "cancelled",
            "id": 4,
            "label": "Cancelled",
            "order": 4
        }
    ]
}

Invoice Payment Mode Types​

GET /api/v3/fa/static/invoice-payment-modes

Get a list of payment mode type IDs.

Payment Mode Type IDs
1
PayPal		Payment by PayPal
2
Check		Payment by check
3
Wire Transfer		Payment by wire transfer
Response 200
{
    "success": true,
    "data": [
        {
            "name": "paypal",
            "id": 1,
            "label": "PayPal",
            "order": 1
        },
        {
            "name": "cheque",
            "id": 2,
            "label": "Cheque",
            "order": 2
        },
        {
            "name": "wire_transfer",
            "id": 3,
            "label": "Wire Transfer",
            "order": 3
        }
    ]
}

Invoice Status​

GET /api/v3/fa/static/invoice-status

Get a list of invoice status type IDs.

Invoice Status IDs
1
Pending		Invoice pending
2
Partially Paid		Invoice partially paid
3
Unpaid		Invoice not paid
4
Paid		Invoice paid
5
Overdue		Invoice payment overdue
7
Processing		Invoice payment processing
8
Cancelled		Invoice payment cancelled
Response 200
{
    "success": true,
    "data": [
        {
            "name": "pending",
            "id": 1,
            "label": "Pending",
            "order": 1
        },
        {
            "name": "partially_paid",
            "id": 2,
            "label": "Partially Paid",
            "order": 2
        },
        {
            "name": "unpaid",
            "id": 3,
            "label": "Unpaid",
            "order": 3
        },
        {
            "name": "paid",
            "id": 4,
            "label": "Paid",
            "order": 4
        },
        {
            "name": "overdue",
            "id": 5,
            "label": "Overdue",
            "order": 5
        },
        {
            "name": "processing",
            "id": 7,
            "label": "Processing",
            "order": 7
        },
        {
            "name": "cancelled",
            "id": 8,
            "label": "Cancelled",
            "order": 8
        }
    ]
}

Invoice Payment Term​

GET /api/v3/fa/static/invoice-payment-terms
Payment Term IDs
1
Net 7		Payment expected within 7 days of invoice date
2
Net 15		Payment expected within 15 days of invoice date
3
Net 30		Payment expected within 30 days of invoice date
4
Net 45		Payment expected within 45 days of invoice date
5
Net 60		Payment expected within 60 days of invoice date
6
Net 90		Payment expected within 90 days of invoice date
7
Net 120		Payment expected within 120 days of invoice date
8
Custom		Payment expected within set days of invoice date
{
    "success": true,
    "data": [
        {
            "name": "7",
            "id": 1,
            "label": "Net 7",
            "order": 1
        },
        {
            "name": "15",
            "id": 2,
            "label": "Net 15",
            "order": 2
        },
        {
            "name": "30",
            "id": 3,
            "label": "Net 30",
            "order": 3
        },
        {
            "name": "45",
            "id": 4,
            "label": "Net 45",
            "order": 4
        },
        {
            "name": "60",
            "id": 5,
            "label": "Net 60",
            "order": 5
        },
        {
            "name": "90",
            "id": 6,
            "label": "Net 90",
            "order": 6
        },
        {
            "name": "120",
            "id": 7,
            "label": "Net 120",
            "order": 7
        },
        {
            "name": "0",
            "id": 8,
            "label": "Custom",
            "order": 8
        }
    ]
}

PG Payment Type​

GET /api/v3/fa/static/pg/payment-type

Get a list of PG payment type IDs.

PG Payment Type IDs
1Publisher payment
2 Platform payment
Response 200
{
    "success": true,
    "data": {
        "totalRecords": 2,
        "filteredRecords": 2,
        "pgPaymentTypes": [
            {
                "id": 1,
                "name": "publisher",
                "label": "Publisher",
                "order": 1
            },
            {
                "id": 2,
                "name": "platform",
                "label": "Platform",
                "order": 2
            }
        ]
    }
}