Package vn.payos.service.async.v1.payouts

Interface PayoutsService

All Known Implementing Classes:
PayoutsServiceImpl
public interface PayoutsService
PayoutsService

  • Method Details

    • create

      CompletableFuture<Payout> create(PayoutRequests payoutData, String idempotencyKey, RequestOptions<PayoutRequests> options)
      Create a new payout.
      Parameters:
      payoutData - The details of the payout to be created.
      idempotencyKey - A unique key for ensuring idempotency. Use a UUID or other high-entropy string so that retries of the same request are recognized and duplicated payouts are prevented.
      options - Additional options.
      Returns:
      Payout detail.

    • create

      CompletableFuture<Payout> create(PayoutRequests payoutData, RequestOptions<PayoutRequests> options)
      Create a new payout.
      Parameters:
      payoutData - The details of the payout to be created.
      options - Additional options.
      Returns:
      Payout detail.

    • create

      CompletableFuture<Payout> create(PayoutRequests payoutData, String idempotencyKey)
      Create a new payout.
      Parameters:
      payoutData - The details of the payout to be created.
      idempotencyKey - A unique key for ensuring idempotency. Use a UUID or other high-entropy string so that retries of the same request are recognized and duplicated payouts are prevented.
      Returns:
      Payout detail.

    • create

      CompletableFuture<Payout> create(PayoutRequests payoutData)
      Create a new payout.
      Parameters:
      payoutData - The details of the payout to be created.
      Returns:
      Payout detail.

    • get

      CompletableFuture<Payout> get(String payoutId, RequestOptions<Void> options)
      Retrieves detailed information about a specific payout.
      Parameters:
      payoutId - The unique identifier of the payout to retrieve.
      options - Additional options.
      Returns:
      Payout detail.

    • get

      CompletableFuture<Payout> get(String payoutId)
      Retrieves detailed information about a specific payout.
      Parameters:
      payoutId - The unique identifier of the payout to retrieve.
      Returns:
      Payout detail.

    • estimateCredit

      CompletableFuture<EstimateCredit> estimateCredit(PayoutRequests payoutData, RequestOptions<PayoutRequests> options)
      Estimate credit required for one payout.
      Parameters:
      payoutData - The details of the payout to be estimated.
      options - Additional options.
      Returns:
      The estimate result.

    • estimateCredit

      CompletableFuture<EstimateCredit> estimateCredit(PayoutRequests payoutData)
      Estimate credit required for one payout.
      Parameters:
      payoutData - The details of the payout to be estimated.
      Returns:
      The estimate result.

    • estimateCredit

      CompletableFuture<EstimateCredit> estimateCredit(PayoutBatchRequest payoutData, RequestOptions<PayoutBatchRequest> options)
      Estimate credit required for batch payout.
      Parameters:
      payoutData - The details of the payout to be estimated.
      options - Additional options.
      Returns:
      The estimate result.

    • estimateCredit

      CompletableFuture<EstimateCredit> estimateCredit(PayoutBatchRequest payoutData)
      Estimate credit required for batch payout.
      Parameters:
      payoutData - The details of the payout to be estimated.
      Returns:
      The estimate result.

    • list

      CompletableFuture<PageAsync<Payout>> list(GetPayoutListParams params, RequestOptions<Void> options)
      Retrieves a paginated list of payouts filtered by the given criteria.
      Parameters:
      params - The filtering options including pagination parameters.
      options - Additional options.
      Returns:
      The payouts detail.

    • list

      CompletableFuture<PageAsync<Payout>> list(GetPayoutListParams params)
      Retrieves a paginated list of payouts filtered by the given criteria.
      Parameters:
      params - The filtering options including pagination parameters.
      Returns:
      The payouts detail.

    • batch

      BatchService batch()
      BatchService
      Returns:
      BatchService