v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get payments

get/payments/transactions

Query parameters

pagestring

countstring

sort'ASC' | 'DESC'

sort_by'created_at' | 'updated_at'

filter.customer_uidstring

filter.action_modulestring

filter.amount_fromstring

filter.amount_tostring

filter.from_datestring

filter.to_datestring

filter.organization_uidstring

filter.payment_mode_uidstring

filter.payment_provider_uidstring

filter.payment_statusstring

filter.action_uidstring

filter.is_disputedboolean

filter.is_refundedboolean

transaction_idstring

filter.credit_used_uidstring[]

filter.credit_issued_uidstring[]

filter.business_unitstring

filter.payment_via'PAYMENT_METHOD' | 'CREDIT'

Response

200

typestring

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "payment_transaction_uid": "9e8cdfcc-3e9d-4673-b4fc-0312b6f50c3b",
      "currency": "USD",
      "amount": 120,
      "description": "Transaction via offline payment",
      "payment_mode": {
        "payment_mode_uid": "a3cde638-ec48-432d-9b7f-aefe94f4501d",
        "payment_mode_name": "Cash",
        "payment_mode_type": "OFFLINE",
        "payment_mode_description": "cash"
      },
      "customer": {
        "customer_uid": "2fe1af90-da07-11ee-9054-0be1fec3fea9",
        "customer_first_name": "Arunkumar R R",
        "customer_email": "arunkumar.r@zuper.co",
        "is_active": true
      },
      "organization": {
        "organization_uid": "04a02310-b424-11ee-98b3-c914c66fec20",
        "organization_name": "Ak's org",
        "organization_email": "arunkumar.r@zuper.co",
        "no_of_customers": 6,
        "is_active": true
      },
      "action_module": "INVOICE",
      "action_uid": "c8b0b9e8-6eba-4d68-86fb-277de371014a",
      "type": "OFFLINE",
      "source": "MOBILE_APP",
      "status": "SUCCESS",
      "created_at": "2024-07-02T09:48:20.308Z",
      "updated_at": "2024-07-02T09:48:20.309Z",
      "user": {
        "user_uid": "d30d95ba-43fb-4568-9550-715858629f02",
        "first_name": "Trevor",
        "last_name": "Alan",
        "email": "iOS.fe@zuper.co",
        "external_login_id": "9789290838",
        "home_phone_number": "9876543210",
        "designation": "Technician",
        "emp_code": "1234",
        "work_phone_number": "9876543211",
        "mobile_phone_number": "US, UK, CANADA",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/2700dd00-df27-11ed-99a7-fb2773a094b7.png",
        "hourly_labor_charge": 120,
        "is_active": true,
        "created_at": "2018-07-26T04:26:24.000Z",
        "updated_at": "2024-03-20T10:54:28.000Z",
        "role": {
          "role_id": 3,
          "role_uid": "504e52bc-ff7d-11e7-8be5-0ed5f89f718b",
          "role_name": "Field Executive",
          "role_key": "FIELD_EXECUTIVE",
          "created_at": "2018-01-22T00:00:00.000Z",
          "updated_at": "2018-01-22T00:00:00.000Z"
        }
      }
    }
  ],
  "total_records": 1,
  "current_page": 1,
  "total_pages": 1
}