Package ru.loolzaaa.youkassa.processors

Class PayoutProcessor

java.lang.Object
ru.loolzaaa.youkassa.processors.PayoutProcessor
public class PayoutProcessor extends 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 Details

    • PayoutProcessor

      public PayoutProcessor()

  • Method Details

    • findById

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

    • findAll

      public PaginatedResponse<Payout> findAll(PayoutList payoutList)
      Receive information about all payouts with some filter conditions.
      Parameters:
      payoutList - collection with filter conditions
      Returns:
      listed payout entities
      See Also:

    • searchByMetadata

      public PaginatedResponse<Payout> searchByMetadata(PayoutList payoutList)
      Search information about payouts with metadata filter conditions.
      Parameters:
      payoutList - collection with filter conditions
      Returns:
      listed payout entities
      See Also:

    • create

      public Payout create(Payout payoutParams, 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:
      IllegalArgumentException - if payout parameters is null