Skip to main content

PaymentCreateRequestDTO

Payment create request body.

The required ID field depends on base:

  • CONTRACT / SURCHARGEcontractId required
  • BOOKINGbookingId required
  • CLIENT / CASHBACKclientId required

When type is CUSTOM, customTypeId is also required.

basePaymentBaserequired

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
amountdoublerequired

Payment amount (min 0.01).

Possible values: >= 0.01

Example: 5000000
typePaymentTyperequired

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
contractIdint64

Contract ID. Required when base is CONTRACT or SURCHARGE.

Example: 1409
bookingIdint64

Booking ID. Required when base is BOOKING.

Example: 512
clientIdint64

Client ID. Required when base is CLIENT or CASHBACK.

Example: 3001
currencyIdint32

Currency ID (optional; defaults to the company's basic currency).

Example: 2
notestring

Free-text note (optional).

Example: Advance payment
timestampint64

Payment date (epoch seconds, optional). Defaults to current time if omitted.

Example: 1718000000
customTypeIdint64

Custom payment type ID. Required when type is CUSTOM.

Example: 5
PaymentCreateRequestDTO
{
"base": "CONTRACT",
"amount": 5000000,
"type": "CASH",
"contractId": 1409,
"bookingId": 512,
"clientId": 3001,
"currencyId": 2,
"note": "Advance payment",
"timestamp": 1718000000,
"customTypeId": 5
}