Skip to main content

PaymentInfoDTO

Full payment details object. Returned by GET /v1/open-api/payment/{id}.

idint64

Payment ID

Example: 98765
uuidstringnullable

Payment UUID

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
numberstring

Payment number

Example: PAY-00123
amountdouble

Payment amount

Example: 5000000
basePaymentBase

Payment source enum — which entity the payment belongs to.

  • CONTRACT — Contract payment
  • SURCHARGE — Fine / penalty payment
  • CLIENT — Client balance top-up
  • BOOKING — Booking (reservation) payment
  • CASHBACK — Cashback payment

Possible values: [CONTRACT, SURCHARGE, CLIENT, BOOKING, CASHBACK]

Example: CONTRACT
typePaymentType

Payment method enum.

  • CARD — Card
  • CASH — Cash
  • TRANSFER — Transfer (card to card)
  • BALANCE — From client balance
  • BANK — Via bank
  • PAYME — Payme
  • MY_UZCARD — MyUzcard
  • UZUM — Uzum
  • PAYLOV — Paylov
  • UYSOT_PAY — Uysot pay
  • ATMOS — Atmos
  • OTHERS — Others
  • CUSTOM — Custom
  • CASHBACK — Cashback
  • CLICK — Click

Possible values: [CARD, CASH, TRANSFER, BALANCE, BANK, PAYME, MY_UZCARD, UZUM, PAYLOV, UYSOT_PAY, ATMOS, OTHERS, CUSTOM, CASHBACK, CLICK]

Example: CASH
debitPaymentDebit

Payment direction enum.

  • INCOME — Income
  • OUTCOME — Outcome

Possible values: [INCOME, OUTCOME]

Example: INCOME
notestringnullable

Payment note

Example: Advance payment
mortgagebooleannullable

Whether it is a mortgage payment

Example: false
customTypeNamestringnullable

Custom payment type name (present when type is CUSTOM)

Example: Online payment
timestampint64nullable

Payment date (epoch seconds)

Example: 1718000000
createdTimestampint64nullable

System entry time (epoch seconds)

Example: 1718001000
payerIdint64nullable

Payer client ID

Example: 3001
payerstring

Payer client full name

Example: Aliyev Vohid
payerPhonesstring[]

Payer client phone numbers.

Example: ["+998901234567"]
createdByIdint32nullable

ID of the employee who created the payment

Example: 42
createdBystring

Full name of the employee who created the payment

Example: Toshmatov Saidakbar
currency object

Currency information object.

idint32

Currency ID

Example: 1
valuedouble

Exchange rate (1 for the basic currency)

Example: 1
updateTimestampint64

Last update time (epoch seconds)

Example: 1672531200
basicboolean

Whether it's the company's basic currency

Example: true
ccystring

Currency code

Example: USD
exchangedoublenullable

Exchange rate at time of payment

Example: 12800
basicExchangedoublenullable

Exchange rate in the basic currency

Example: 1
branchIdint32nullable

Branch ID

Example: 1
branchNamestringnullable

Branch name

Example: Chilonzor
buildingIdint32nullable

Building ID

Example: 10
buildingNamestringnullable

Building name

Example: A blok
houseIdint32nullable

House (residential complex) ID

Example: 2
houseNamestringnullable

House (residential complex) name

Example: Navruz
contractIdint32nullable

Contract ID (present for CONTRACT / SURCHARGE payments)

Example: 1409
contractNumberstringnullable

Contract number (present for CONTRACT / SURCHARGE payments)

Example: SH-2024-001
bookingIdint64nullable

Booking ID (present for BOOKING payments)

Example: 512
canceledTimestampint64nullable

Cancellation time (epoch seconds)

Example: 1718100000
cancelNotestringnullable

Cancellation reason

Example: Wrong payment
canceledByIdint32nullable

ID of the employee who cancelled the payment

Example: 5
canceledBystringnullable

Full name of the employee who cancelled the payment

Example: Karimov Jasur
PaymentInfoDTO
{
  "id": 98765,
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "number": "PAY-00123",
  "amount": 5000000,
  "base": "CONTRACT",
  "type": "CASH",
  "debit": "INCOME",
  "note": "Advance payment",
  "mortgage": false,
  "customTypeName": "Online payment",
  "timestamp": 1718000000,
  "createdTimestamp": 1718001000,
  "payerId": 3001,
  "payer": "Aliyev Vohid",
  "payerPhones": [
    "+998901234567"
  ],
  "createdById": 42,
  "createdBy": "Toshmatov Saidakbar",
  "currency": {
    "id": 1,
    "value": 1,
    "updateTimestamp": 1672531200,
    "basic": true,
    "ccy": "USD"
  },
  "exchange": 12800,
  "basicExchange": 1,
  "branchId": 1,
  "branchName": "Chilonzor",
  "buildingId": 10,
  "buildingName": "A blok",
  "houseId": 2,
  "houseName": "Navruz",
  "contractId": 1409,
  "contractNumber": "SH-2024-001",
  "bookingId": 512,
  "canceledTimestamp": 1718100000,
  "cancelNote": "Wrong payment",
  "canceledById": 5,
  "canceledBy": "Karimov Jasur"
}