Skip to main content

PaymentDTO

Payment information object.

idint64

Payment ID

Example: 10001
numberstring

Payment number

Example: PAY-2023-001
amountdouble

Payment amount

Example: 5000
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
debtPaymentDebit

Payment direction enum.

  • INCOME — Income
  • OUTCOME — Outcome

Possible values: [INCOME, OUTCOME]

Example: INCOME
createdBystring

Employee who created the payment

Example: Alice Johnson
createdTimestampint64

Creation time (epoch seconds)

Example: 1672531200
canceledTimestampint64

Cancellation time (epoch seconds)

Example: 1672617600
cancelNotestring

Cancellation reason

Example: Duplicate payment
payerIdint64

Payer client ID

Example: 1001
payerstring

Payer name

Example: John Doe
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
notestring

Payment note

Example: Advance payment
timestampint64

Payment time (epoch seconds)

Example: 1672531200
mortgageboolean

Whether it is a mortgage payment

Example: false
customTypeNamestring

Custom payment type name (when type is CUSTOM)

Example: PayPal
contractIdint32nullable

Contract ID (present when base is CONTRACT or SURCHARGE)

Example: 1409
bookingIdint64nullable

Booking ID (present when base is BOOKING)

Example: 512
PaymentDTO
{
  "id": 10001,
  "number": "PAY-2023-001",
  "amount": 5000,
  "base": "CONTRACT",
  "type": "CASH",
  "debt": "INCOME",
  "createdBy": "Alice Johnson",
  "createdTimestamp": 1672531200,
  "canceledTimestamp": 1672617600,
  "cancelNote": "Duplicate payment",
  "payerId": 1001,
  "payer": "John Doe",
  "currency": {
    "id": 1,
    "value": 1,
    "updateTimestamp": 1672531200,
    "basic": true,
    "ccy": "USD"
  },
  "note": "Advance payment",
  "timestamp": 1672531200,
  "mortgage": false,
  "customTypeName": "PayPal",
  "contractId": 1409,
  "bookingId": 512
}