---
title: "payerResponses"
method: GET
path: "/api/user/ayria-payments/payer-responses/all"
tags: ["ayria-payment-user-resource"]
---

# payerResponses

`GET /api/user/ayria-payments/payer-responses/all`

## Request

- Base URL: `https://api.neonclub.ir`
- URL: `https://api.neonclub.ir/api/user/ayria-payments/payer-responses/all`
- Auth: none declared
- TypeScript: <https://skmtc.dev/neonclub/apis/ayria-api/docs/api/user/ayria-payments/payer-responses/all/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `amount.equals` number
- `amount.greaterThan` number
- `amount.greaterThanOrEqual` number
- `amount.in` number[]
- `amount.lessThan` number
- `amount.lessThanOrEqual` number
- `amount.notEquals` number
- `amount.notIn` number[]
- `amount.specified` boolean
- `archived.equals` boolean
- `archived.in` boolean[]
- `archived.notEquals` boolean
- `archived.notIn` boolean[]
- `archived.specified` boolean
- `cancelDescription.contains` string
- `cancelDescription.doesNotContain` string
- `cancelDescription.equals` string
- `cancelDescription.in` string[]
- `cancelDescription.notEquals` string
- `cancelDescription.notIn` string[]
- `cancelDescription.specified` boolean
- `canceled.equals` boolean
- `canceled.in` boolean[]
- `canceled.notEquals` boolean
- `canceled.notIn` boolean[]
- `canceled.specified` boolean
- `createdDate.equals` string, date-time
- `createdDate.greaterThan` string, date-time
- `createdDate.greaterThanOrEqual` string, date-time
- `createdDate.in[0].epochSecond` integer
- `createdDate.in[0].nano` integer
- `createdDate.lessThan` string, date-time
- `createdDate.lessThanOrEqual` string, date-time
- `createdDate.notEquals` string, date-time
- `createdDate.notIn[0].epochSecond` integer
- `createdDate.notIn[0].nano` integer
- `createdDate.specified` boolean
- `createdDateTo.equals` string, date-time
- `createdDateTo.greaterThan` string, date-time
- `createdDateTo.greaterThanOrEqual` string, date-time
- `createdDateTo.in[0].epochSecond` integer
- `createdDateTo.in[0].nano` integer
- `createdDateTo.lessThan` string, date-time
- `createdDateTo.lessThanOrEqual` string, date-time
- `createdDateTo.notEquals` string, date-time
- `createdDateTo.notIn[0].epochSecond` integer
- `createdDateTo.notIn[0].nano` integer
- `createdDateTo.specified` boolean
- `deliverable.equals` boolean
- `deliverable.in` boolean[]
- `deliverable.notEquals` boolean
- `deliverable.notIn` boolean[]
- `deliverable.specified` boolean
- `delivered.equals` boolean
- `delivered.in` boolean[]
- `delivered.notEquals` boolean
- `delivered.notIn` boolean[]
- `delivered.specified` boolean
- `deliveredDate.equals` string, date-time
- `deliveredDate.greaterThan` string, date-time
- `deliveredDate.greaterThanOrEqual` string, date-time
- `deliveredDate.in[0].epochSecond` integer
- `deliveredDate.in[0].nano` integer
- `deliveredDate.lessThan` string, date-time
- `deliveredDate.lessThanOrEqual` string, date-time
- `deliveredDate.notEquals` string, date-time
- `deliveredDate.notIn[0].epochSecond` integer
- `deliveredDate.notIn[0].nano` integer
- `deliveredDate.specified` boolean
- `deliveryManId.equals` integer
- `deliveryManId.greaterThan` integer
- `deliveryManId.greaterThanOrEqual` integer
- `deliveryManId.in` integer[]
- `deliveryManId.lessThan` integer
- `deliveryManId.lessThanOrEqual` integer
- `deliveryManId.notEquals` integer
- `deliveryManId.notIn` integer[]
- `deliveryManId.specified` boolean
- `description.contains` string
- `description.doesNotContain` string
- `description.equals` string
- `description.in` string[]
- `description.notEquals` string
- `description.notIn` string[]
- `description.specified` boolean
- `extraData.contains` string
- `extraData.doesNotContain` string
- `extraData.equals` string
- `extraData.in` string[]
- `extraData.notEquals` string
- `extraData.notIn` string[]
- `extraData.specified` boolean
- `issuerMustVerifyPayment.equals` boolean
- `issuerMustVerifyPayment.in` boolean[]
- `issuerMustVerifyPayment.notEquals` boolean
- `issuerMustVerifyPayment.notIn` boolean[]
- `issuerMustVerifyPayment.specified` boolean
- `lastModifiedDate.equals` string, date-time
- `lastModifiedDate.greaterThan` string, date-time
- `lastModifiedDate.greaterThanOrEqual` string, date-time
- `lastModifiedDate.in[0].epochSecond` integer
- `lastModifiedDate.in[0].nano` integer
- `lastModifiedDate.lessThan` string, date-time
- `lastModifiedDate.lessThanOrEqual` string, date-time
- `lastModifiedDate.notEquals` string, date-time
- `lastModifiedDate.notIn[0].epochSecond` integer
- `lastModifiedDate.notIn[0].nano` integer
- `lastModifiedDate.specified` boolean
- `page` integer
- `paid.equals` boolean
- `paid.in` boolean[]
- `paid.notEquals` boolean
- `paid.notIn` boolean[]
- `paid.specified` boolean
- `payeeAcceptorId.equals` integer
- `payeeAcceptorId.greaterThan` integer
- `payeeAcceptorId.greaterThanOrEqual` integer
- `payeeAcceptorId.in` integer[]
- `payeeAcceptorId.lessThan` integer
- `payeeAcceptorId.lessThanOrEqual` integer
- `payeeAcceptorId.notEquals` integer
- `payeeAcceptorId.notIn` integer[]
- `payeeAcceptorId.specified` boolean
- `payeeReferralCode.equals` integer
- `payeeReferralCode.greaterThan` integer
- `payeeReferralCode.greaterThanOrEqual` integer
- `payeeReferralCode.in` integer[]
- `payeeReferralCode.lessThan` integer
- `payeeReferralCode.lessThanOrEqual` integer
- `payeeReferralCode.notEquals` integer
- `payeeReferralCode.notIn` integer[]
- `payeeReferralCode.specified` boolean
- `payeeType.equals` 'USER' | 'ACCEPTOR'
- `payeeType.in` string[]
- `payeeType.notEquals` 'USER' | 'ACCEPTOR'
- `payeeType.notIn` string[]
- `payeeType.specified` boolean
- `payeeUserId.equals` integer
- `payeeUserId.greaterThan` integer
- `payeeUserId.greaterThanOrEqual` integer
- `payeeUserId.in` integer[]
- `payeeUserId.lessThan` integer
- `payeeUserId.lessThanOrEqual` integer
- `payeeUserId.notEquals` integer
- `payeeUserId.notIn` integer[]
- `payeeUserId.specified` boolean
- `payer.contains` string
- `payer.doesNotContain` string
- `payer.equals` string
- `payer.in` string[]
- `payer.notEquals` string
- `payer.notIn` string[]
- `payer.specified` boolean
- `payerAddress.contains` string
- `payerAddress.doesNotContain` string
- `payerAddress.equals` string
- `payerAddress.in` string[]
- `payerAddress.notEquals` string
- `payerAddress.notIn` string[]
- `payerAddress.specified` boolean
- `payerMobile.contains` string
- `payerMobile.doesNotContain` string
- `payerMobile.equals` string
- `payerMobile.in` string[]
- `payerMobile.notEquals` string
- `payerMobile.notIn` string[]
- `payerMobile.specified` boolean
- `payerName.contains` string
- `payerName.doesNotContain` string
- `payerName.equals` string
- `payerName.in` string[]
- `payerName.notEquals` string
- `payerName.notIn` string[]
- `payerName.specified` boolean
- `payerUserId.equals` integer
- `payerUserId.greaterThan` integer
- `payerUserId.greaterThanOrEqual` integer
- `payerUserId.in` integer[]
- `payerUserId.lessThan` integer
- `payerUserId.lessThanOrEqual` integer
- `payerUserId.notEquals` integer
- `payerUserId.notIn` integer[]
- `payerUserId.specified` boolean
- `paymentMethod.equals` 'WALLET' | 'CASH' | 'POS'
- `paymentMethod.in` string[]
- `paymentMethod.notEquals` 'WALLET' | 'CASH' | 'POS'
- `paymentMethod.notIn` string[]
- `paymentMethod.specified` boolean
- `paymentNumber.contains` string
- `paymentNumber.doesNotContain` string
- `paymentNumber.equals` string
- `paymentNumber.in` string[]
- `paymentNumber.notEquals` string
- `paymentNumber.notIn` string[]
- `paymentNumber.specified` boolean
- `referenceCode.contains` string
- `referenceCode.doesNotContain` string
- `referenceCode.equals` string
- `referenceCode.in` string[]
- `referenceCode.notEquals` string
- `referenceCode.notIn` string[]
- `referenceCode.specified` boolean
- `size` integer
- `sort` string[]
- `trackingCode.contains` string
- `trackingCode.doesNotContain` string
- `trackingCode.equals` string
- `trackingCode.in` string[]
- `trackingCode.notEquals` string
- `trackingCode.notIn` string[]
- `trackingCode.specified` boolean
- `trackingNumber.equals` integer
- `trackingNumber.greaterThan` integer
- `trackingNumber.greaterThanOrEqual` integer
- `trackingNumber.in` integer[]
- `trackingNumber.lessThan` integer
- `trackingNumber.lessThanOrEqual` integer
- `trackingNumber.notEquals` integer
- `trackingNumber.notIn` integer[]
- `trackingNumber.specified` boolean

## Response `200`

OK

- AyriaPaymentDTO[]
  - `amount` number
  - `archived` boolean
  - `callbackUrl` string
  - `cancelDescription` string
  - `canceled` boolean
  - `cashier` string
  - `cashierName` string
  - `createdDate` string
  - `createdDateOriginal` string, date-time
  - `createdDatePersian` string
  - `createdTime` string
  - `creditAmount` number
  - `customerAmountActual` number
  - `defaultCallbackUrl` string
  - `deliverable` boolean
  - `delivered` boolean
  - `deliveryAddress` string
  - `deliveryMan` string
  - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING'
  - `description` string
  - `discountAmount` number
  - `insuranceAmount` number
  - `ipgAttempts` integer
  - `issuerMustVerifyPayment` boolean
  - `kalas` ImmutableKalaDTO[]
    - `count` integer
    - `description` string
    - `name` string
    - `price` number
    - `totalPrice` number
  - `number` integer
  - `onlineOrder` boolean
  - `orderDone` boolean
  - `paid` boolean
  - `paidDatePersian` string
  - `paidTimePersian` string
  - `payeeIdentity` string
  - `payeeName` string
  - `payeeReferralCode` integer
  - `payeeType` 'USER' | 'ACCEPTOR'
  - `payerAddress` string
  - `payerMember` boolean
  - `payerMobile` string
  - `payerName` string
  - `paymentMethod` 'WALLET' | 'CASH' | 'POS'
  - `paymentStatus` 'DEFAULT' | 'WAITING_FOR_VERIFY' | 'VERIFIED'
  - `paymentText` string
  - `paymentUrl` string
  - `pickupNotify` integer
  - `receiveDate` string
  - `receiveTime` string
  - `receiveType` 'DELIVERY' | 'TABLES' | 'PICKUP'
  - `referenceCode` string
  - `score` number
  - `shippingAddressId` integer
  - `shippingFee` number
  - `shippingGeo` string
  - `shippingStatus` 'REGISTERED' | 'PICKED' | 'CONSIDERED' | 'ON_MOVE' | 'DELIVERED' | 'REFUNDED'
  - `tableIdentifier` string
  - `tax` number
  - `terminal` string
  - `tip` number
  - `trackingNumber` integer
  - `unitedAmount` number
  - `voucherAmount` number
  - `waiter` string

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/neonclub/apis/ayria-api.md) - [All operations](https://skmtc.dev/neonclub/apis/ayria-api/llms.txt) - [OpenAPI document](https://skmtc.dev/neonclub/apis/ayria-api/revisions/1f6b876e9f89?raw)
