Class ReceiptProcessor


  • public class ReceiptProcessor
    extends java.lang.Object
    Processor for Receipt entity.

    Using the API, you can receive information about receipts for which you sent data through YooKassa.

    Use ApiClient for API server communication.

    API Note:
    For those who use the YooKassa solution for 54-FZ
    • Constructor Detail

      • ReceiptProcessor

        public ReceiptProcessor()
    • Method Detail

      • findById

        public Receipt findById​(java.lang.String receiptId)
        Receive information about some Receipt by its identifier.
        Parameters:
        receiptId - receipt identifier
        Returns:
        receipt entity with actual status
        Throws:
        java.lang.IllegalArgumentException - if receipt id is null or empty
      • findAll

        public PaginatedResponse<Receipt> findAll​(ReceiptList receiptList)
        Receive information about all receipts with some filter conditions.
        Parameters:
        receiptList - collection with filter conditions
        Returns:
        listed payout entities
        See Also:
        PaginatedResponse
      • create

        public Receipt create​(Receipt receiptParams,
                              java.lang.String idempotencyKey)
        Creates new Receipt entity with certain parameters.

        Generate random idempotency key if corresponding argument is null.

        Parameters:
        receiptParams - parameters for new receipt
        idempotencyKey - idempotency key
        Returns:
        new receipt entity with actual status
        Throws:
        java.lang.IllegalArgumentException - if receipt parameters is null