ListPayments

About ListPayments

This API filters the payments based on the disbursement status, where 0 = scheduled payment, 3 = payment sent, 4 = payment failed, and 5 = void payment.

Example

Request

<API_URL_EndPoint>ListPayments.json

data={
   "disbursementStatus" :  "3",
   "start" : 0,
   "max" : 999
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : {
    "payments" : [ {
      "entity" : "SentPay",
      "id" : "stp01WYJMFAYIDD3c2lg",
      "processDate" : "2016-12-09",
      "amount" : 10.00,
      "status" : "2",
      "description" : "Inv #321",
      "txnNumber" : "DVUYNCLIPYSLIVOREMOE",
      "name" : "P16120801 - 0747568",
      "vendorId" : "00901FABIIZFVKV2pzsy",
      "isOnline" : true,
      "paymentType" : "0",
      "chartOfAccountId" : "0ca01XBBGGQFHTKUdgcc",
      "syncReference" : null,
      "toPrintCheck" : false,
      "createdTime" : "2016-12-08T19:56:13.000+0000",
      "updatedTime" : "2016-12-09T08:00:16.000+0000",
      "bankAccountId" : "bac01MHFFKRYWKIJ8nai",
      "billPays" : [ {
        "entity" : "BillPay",
        "id" : "blp01VXNYOBBBCO6ecvk",
        "billId" : "00n01HPMBLLCNKQ3yb1r",
        "name" : "P16120801 - 0747568",
        "paymentStatus" : "2",
        "amount" : 10.00,
        "description" : "Inv #321",
        "processDate" : "2016-12-09",
        "createdTime" : "2016-12-08T19:56:13.000+0000",
        "updatedTime" : "2016-12-09T00:02:37.000+0000",
        "paymentType" : "0",
        "syncReference" : null,
        "toPrintCheck" : false,
        "chartOfAccountId" : "0ca01XBBGGQFHTKUdgcc"
      } ],
      "billCredits" : [ ],
      "voidRequests" : [ ]
    }, {
      "entity" : "SentPay",
      "id" : "stp01SQMEGFJWGV37y5f",
      "processDate" : "2016-09-23",
      "amount" : 500.00,
      "status" : "2",
      "description" : "Acct #650-Inv #002",
      "txnNumber" : "IWZWNLRJZHGKKQELKJWY",
      "name" : "P16092201 - 0365398",
      "vendorId" : "00901AURFVMCQRQ2pzw6",
      "isOnline" : true,
      "paymentType" : "1",
      "chartOfAccountId" : "0ca01XBBGGQFHTKUdgcc",
      "syncReference" : null,
      "toPrintCheck" : false,
      "createdTime" : "2016-09-22T14:15:32.000+0000",
      "updatedTime" : "2016-09-23T07:00:17.000+0000",
      "bankAccountId" : "bac01OOZNCHMLQNK8naj",
      "billPays" : [ {
        "entity" : "BillPay",
        "id" : "blp01GDUBSKDMVC665zq",
        "billId" : "00n01ROHVWMZHOB3sviu",
        "name" : "P16092201 - 0365398",
        "paymentStatus" : "2",
        "amount" : 500.00,
        "description" : "Acct #650-Inv #002",
        "processDate" : "2016-09-23",
        "createdTime" : "2016-09-22T14:15:32.000+0000",
        "updatedTime" : "2016-09-22T23:05:19.000+0000",
        "paymentType" : "0",
        "syncReference" : null,
        "toPrintCheck" : false,
        "chartOfAccountId" : "0ca01XBBGGQFHTKUdgcc"
      } ],
      "billCredits" : [ ],
      "voidRequests" : [ ]
    } ]
  }
}

Parameters