com.mangopay.core.APIs

Interface PayOutApi

All Known Implementing Classes:

PayOutApiImpl

public interface PayOutApi

Created by thepa on 18-Jan-17.

Method Summary

Modifier and Type	Method and Description
PayOutEligibilityResult	checkInstantPayoutEligibility(java.lang.String idempotencyKey, PayOutEligibility payOutEligibility)
PayOut	create(PayOut payOut) Creates new PayOut object.
PayOut	create(java.lang.String idempotencyKey, PayOut payOut) Creates new PayOut object.
PayOut	get(java.lang.String payOutId) Gets PayOut entity by its identifier.
PayOut	getBankwire(java.lang.String payOutId) Gets PayOut Bankwire entity by its identifier.
java.util.List<Refund>	getRefunds(java.lang.String payOutId) Get refunds for a payout
java.util.List<Refund>	getRefunds(java.lang.String payOutId, Pagination pagination, Sorting sorting) Get a page of payout refunds

Method Detail

create

PayOut create(PayOut payOut)
       throws java.lang.Exception

Creates new PayOut object.

Parameters:

payOut - The PayOut object to be created.

Returns:

Created PayOut object returned by API.

Throws:

java.lang.Exception

create

PayOut create(java.lang.String idempotencyKey,
              PayOut payOut)
       throws java.lang.Exception

Creates new PayOut object.

Parameters:

idempotencyKey - idempotency key for this request.

payOut - The PayOut object to be created.

Returns:

Created PayOut object returned by API.

Throws:

java.lang.Exception

checkInstantPayoutEligibility

PayOutEligibilityResult checkInstantPayoutEligibility(java.lang.String idempotencyKey,
                                                      PayOutEligibility payOutEligibility)
                                               throws java.lang.Exception

Parameters:

idempotencyKey - idempotency key for this request.

payOutEligibility - The PayOut object to check

Returns:

PayOutEligibility Result

Throws:

java.lang.Exception

get

PayOut get(java.lang.String payOutId)
    throws java.lang.Exception

Gets PayOut entity by its identifier.

Parameters:

payOutId - PayOut identifier.

Returns:

PayOut instance returned by API.

Throws:

java.lang.Exception

getBankwire

PayOut getBankwire(java.lang.String payOutId)
            throws java.lang.Exception

Gets PayOut Bankwire entity by its identifier.

Parameters:

payOutId - PayOut identifier.

Returns:

PayOut instance returned by API.

Throws:

java.lang.Exception

getRefunds

java.util.List<Refund> getRefunds(java.lang.String payOutId)
                           throws java.lang.Exception

Get refunds for a payout

Parameters:

payOutId - PayOut identifier

Returns:

A list of refunds

Throws:

java.lang.Exception

getRefunds

java.util.List<Refund> getRefunds(java.lang.String payOutId,
                                  Pagination pagination,
                                  Sorting sorting)
                           throws java.lang.Exception

Get a page of payout refunds

Parameters:

payOutId - PayOut identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of payout refunds

Throws:

java.lang.Exception