Package ru.loolzaaa.youkassa.processors

Class PayoutProcessor

  • public class PayoutProcessor
extends java.lang.Object
    Processor for Payout entity.

    A payout is the amount of money you transfer to an individual or self-employed person. Using the API, you can create a payout and get up-to-date information about it.

    Payments are used in the following YuKassa payment solutions:

    • Payouts - you as a company transfer money to individuals and the self-employed (for example, pay out cashback to users).
    • Safe Deal - your platform transfers payment from one individual to another as part of the created transaction.

    Use ApiClient for API server communication.

    • Constructor Summary

      Constructors 
      Constructor Description
      PayoutProcessor()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Payout create​(Payout payoutParams, java.lang.String idempotencyKey)
      Creates new Payout entity with certain parameters.
      Payout findById​(java.lang.String payoutId)
      Receive information about some Payout by its identifier.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PayoutProcessor

        public PayoutProcessor()

    • Method Detail

      • findById

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

      • create

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

        Generate random idempotency key if corresponding argument is null.

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