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

Class PayoutsServiceImpl

java.lang.Object

vn.payos.core.APIService<PayOSAsync>

vn.payos.service.async.v1.payouts.PayoutsServiceImpl

All Implemented Interfaces:

PayoutsService

public class PayoutsServiceImpl
extends APIService<PayOSAsync>
implements PayoutsService

PayoutsServiceImpl

Field Summary

Fields inherited from class vn.payos.core.APIService

client

Constructor Summary

Constructors

Constructor	Description
PayoutsServiceImpl(PayOSAsync client)	PayoutsServiceImpl

Method Summary

Modifier and Type	Method	Description
BatchService	batch()	BatchService
CompletableFuture<Payout>	create(PayoutRequests payoutData)	Create a new payout.
CompletableFuture<Payout>	create(PayoutRequests payoutData, String idempotencyKey)	Create a new payout.
CompletableFuture<Payout>	create(PayoutRequests payoutData, String idempotencyKey, RequestOptions<PayoutRequests> options)	Create a new payout.
CompletableFuture<Payout>	create(PayoutRequests payoutData, RequestOptions<PayoutRequests> options)	Create a new payout.
CompletableFuture<EstimateCredit>	estimateCredit(PayoutBatchRequest payoutData)	Estimate credit required for batch payout.
CompletableFuture<EstimateCredit>	estimateCredit(PayoutBatchRequest payoutData, RequestOptions<PayoutBatchRequest> options)	Estimate credit required for batch payout.
CompletableFuture<EstimateCredit>	estimateCredit(PayoutRequests payoutData)	Estimate credit required for one payout.
CompletableFuture<EstimateCredit>	estimateCredit(PayoutRequests payoutData, RequestOptions<PayoutRequests> options)	Estimate credit required for one payout.
CompletableFuture<Payout>	get(String payoutId)	Retrieves detailed information about a specific payout.
CompletableFuture<Payout>	get(String payoutId, RequestOptions<Void> options)	Retrieves detailed information about a specific payout.
CompletableFuture<PageAsync<Payout>>	list(GetPayoutListParams params)	Retrieves a paginated list of payouts filtered by the given criteria.
CompletableFuture<PageAsync<Payout>>	list(GetPayoutListParams params, RequestOptions<Void> options)	Retrieves a paginated list of payouts filtered by the given criteria.

Methods inherited from class java.lang.Object

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

Constructor Details

PayoutsServiceImpl

public PayoutsServiceImpl(PayOSAsync client)

PayoutsServiceImpl

Parameters:

client - client

Method Details

create

public CompletableFuture<Payout> create(PayoutRequests payoutData,
 String idempotencyKey,
 RequestOptions<PayoutRequests> options)

Description copied from interface: PayoutsService

Create a new payout.

Specified by:

create in interface PayoutsService

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

public CompletableFuture<Payout> create(PayoutRequests payoutData,
 RequestOptions<PayoutRequests> options)

Description copied from interface: PayoutsService

Create a new payout.

Specified by:

create in interface PayoutsService

Parameters:

payoutData - The details of the payout to be created.

options - Additional options.

Returns:

Payout detail.

create

public CompletableFuture<Payout> create(PayoutRequests payoutData,
 String idempotencyKey)

Description copied from interface: PayoutsService

Create a new payout.

Specified by:

create in interface PayoutsService

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

public CompletableFuture<Payout> create(PayoutRequests payoutData)

Description copied from interface: PayoutsService

Create a new payout.

Specified by:

create in interface PayoutsService

Parameters:

payoutData - The details of the payout to be created.

Returns:

Payout detail.

get

public CompletableFuture<Payout> get(String payoutId,
 RequestOptions<Void> options)

Description copied from interface: PayoutsService

Retrieves detailed information about a specific payout.

Specified by:

get in interface PayoutsService

Parameters:

payoutId - The unique identifier of the payout to retrieve.

options - Additional options.

Returns:

Payout detail.

get

public CompletableFuture<Payout> get(String payoutId)

Description copied from interface: PayoutsService

Retrieves detailed information about a specific payout.

Specified by:

get in interface PayoutsService

Parameters:

payoutId - The unique identifier of the payout to retrieve.

Returns:

Payout detail.

estimateCredit

public CompletableFuture<EstimateCredit> estimateCredit(PayoutRequests payoutData,
 RequestOptions<PayoutRequests> options)

Description copied from interface: PayoutsService

Estimate credit required for one payout.

Specified by:

estimateCredit in interface PayoutsService

Parameters:

payoutData - The details of the payout to be estimated.

options - Additional options.

Returns:

The estimate result.

estimateCredit

public CompletableFuture<EstimateCredit> estimateCredit(PayoutRequests payoutData)

Description copied from interface: PayoutsService

Estimate credit required for one payout.

Specified by:

estimateCredit in interface PayoutsService

Parameters:

payoutData - The details of the payout to be estimated.

Returns:

The estimate result.

estimateCredit

public CompletableFuture<EstimateCredit> estimateCredit(PayoutBatchRequest payoutData,
 RequestOptions<PayoutBatchRequest> options)

Description copied from interface: PayoutsService

Estimate credit required for batch payout.

Specified by:

estimateCredit in interface PayoutsService

Parameters:

payoutData - The details of the payout to be estimated.

options - Additional options.

Returns:

The estimate result.

estimateCredit

public CompletableFuture<EstimateCredit> estimateCredit(PayoutBatchRequest payoutData)

Description copied from interface: PayoutsService

Estimate credit required for batch payout.

Specified by:

estimateCredit in interface PayoutsService

Parameters:

payoutData - The details of the payout to be estimated.

Returns:

The estimate result.

list

public CompletableFuture<PageAsync<Payout>> list(GetPayoutListParams params,
 RequestOptions<Void> options)

Description copied from interface: PayoutsService

Retrieves a paginated list of payouts filtered by the given criteria.

Specified by:

list in interface PayoutsService

Parameters:

params - The filtering options including pagination parameters.

options - Additional options.

Returns:

The payouts detail.

list

public CompletableFuture<PageAsync<Payout>> list(GetPayoutListParams params)

Description copied from interface: PayoutsService

Retrieves a paginated list of payouts filtered by the given criteria.

Specified by:

list in interface PayoutsService

Parameters:

params - The filtering options including pagination parameters.

Returns:

The payouts detail.

batch

public BatchService batch()

Description copied from interface: PayoutsService

BatchService

Specified by:

batch in interface PayoutsService

Returns:

BatchService