com.mangopay.core.APIs.implementation

Class PayOutApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.PayOutApiImpl

All Implemented Interfaces:

PayOutApi

public class PayOutApiImpl
extends ApiBase
implements PayOutApi

API for payOuts.

Field Summary

Fields inherited from class com.mangopay.core.APIs.ApiBase

root

Constructor Summary

Constructors

Constructor and Description
PayOutApiImpl(MangoPayApi root) Instantiates new PayOutApiImpl object.

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

Methods inherited from class com.mangopay.core.APIs.ApiBase

createObject, createObject, createObject, getList, getList, getList, getList, getList, getList, getListNoClientId, getObject, getObjectNoClientId, getRequestType, getRequestUrl, getRoot, updateObject, updateObject, updateObject, updateObject

Methods inherited from class java.lang.Object

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

Constructor Detail

PayOutApiImpl

public PayOutApiImpl(MangoPayApi root)

Instantiates new PayOutApiImpl object.

Parameters:

root - Root/parent instance that holds the OAuthToken and Configuration instance.

Method Detail

create

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

Description copied from interface: PayOutApi

Creates new PayOut object.

Specified by:

create in interface PayOutApi

Parameters:

payOut - The PayOut object to be created.

Returns:

Created PayOut object returned by API.

Throws:

java.lang.Exception

create

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

Description copied from interface: PayOutApi

Creates new PayOut object.

Specified by:

create in interface PayOutApi

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

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

Specified by:

checkInstantPayoutEligibility in interface PayOutApi

Parameters:

idempotencyKey - idempotency key for this request.

payOutEligibility - The PayOut object to check

Returns:

PayOutEligibility Result

Throws:

java.lang.Exception

get

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

Description copied from interface: PayOutApi

Gets PayOut entity by its identifier.

Specified by:

get in interface PayOutApi

Parameters:

payOutId - PayOut identifier.

Returns:

PayOut instance returned by API.

Throws:

java.lang.Exception

getBankwire

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

Description copied from interface: PayOutApi

Gets PayOut Bankwire entity by its identifier.

Specified by:

getBankwire in interface PayOutApi

Parameters:

payOutId - PayOut identifier.

Returns:

PayOut instance returned by API.

Throws:

java.lang.Exception

getRefunds

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

Description copied from interface: PayOutApi

Get refunds for a payout

Specified by:

getRefunds in interface PayOutApi

Parameters:

payOutId - PayOut identifier

Returns:

A list of refunds

Throws:

java.lang.Exception

getRefunds

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

Description copied from interface: PayOutApi

Get a page of payout refunds

Specified by:

getRefunds in interface PayOutApi

Parameters:

payOutId - PayOut identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of payout refunds

Throws:

java.lang.Exception