com.mangopay.core.APIs.implementation

Class PayInApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.PayInApiImpl

All Implemented Interfaces:

PayInApi

public class PayInApiImpl
extends ApiBase
implements PayInApi

API for payIns.

Field Summary

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

root

Constructor Summary

Constructors

Constructor and Description
PayInApiImpl(MangoPayApi root, com.google.gson.GsonBuilder gsonBuilder) Instantiates new PayInApiImpl object.

Method Summary

Modifier and Type	Method and Description
PayIn	create(PayIn payIn) Creates new PayIn object.
PayIn	create(java.lang.String idempotencyKey, PayIn payIn) Creates new PayIn object.
CardPreAuthorizedDepositPayIn	createCardPreAuthorizedDepositPayIn(CreateCardPreAuthorizedDepositPayIn payIn, java.lang.String idempotencyKey)
PayIn	createPayPal(PayIn payIn) Creates new PayPal Web PayIn object.
RecurringPayIn	createRecurringPayInCIT(java.lang.String idempotencyKey, RecurringPayInCIT cit)
RecurringPayIn	createRecurringPayInMIT(java.lang.String idempotencyKey, RecurringPayInMIT mit)
RecurringPayment	createRecurringPayment(java.lang.String idempotencyKey, CreateRecurringPayment createRecurringPayment)
Refund	createRefund(java.lang.String payInId, Refund refund) Creates refund for PayIn object.
Refund	createRefund(java.lang.String idempotencyKey, java.lang.String payInId, Refund refund) Creates refund for PayIn object.
PayIn	get(java.lang.String payInId) Gets PayIn entity by its identifier.
RecurringPaymentExtended	getRecurringPayment(java.lang.String payInId)
Refund	getRefund(java.lang.String payInId) Gets refund for PayIn object.
java.util.List<Refund>	getRefunds(java.lang.String payInId) Get first page of payIn refunds
java.util.List<Refund>	getRefunds(java.lang.String payInId, Pagination pagination, Sorting sorting) Get page of payIn refunds
RecurringPaymentExtended	updateRecurringPayment(java.lang.String payInId, RecurringPaymentUpdate payIn)

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

PayInApiImpl

public PayInApiImpl(MangoPayApi root,
                    com.google.gson.GsonBuilder gsonBuilder)

Instantiates new PayInApiImpl object.

Parameters:

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

Method Detail

create

public PayIn create(PayIn payIn)
             throws java.lang.Exception

Description copied from interface: PayInApi

Creates new PayIn object.

Specified by:

create in interface PayInApi

Parameters:

payIn - The PayIn object to be created.

Returns:

Created PayIn object returned by API.

Throws:

java.lang.Exception

create

public PayIn create(java.lang.String idempotencyKey,
                    PayIn payIn)
             throws java.lang.Exception

Description copied from interface: PayInApi

Creates new PayIn object.

Specified by:

create in interface PayInApi

Parameters:

idempotencyKey - Idempotency key for this request.

payIn - The PayIn object to be created.

Returns:

Created PayIn object returned by API.

Throws:

java.lang.Exception

createRecurringPayment

public RecurringPayment createRecurringPayment(java.lang.String idempotencyKey,
                                               CreateRecurringPayment createRecurringPayment)
                                        throws java.lang.Exception

Specified by:

createRecurringPayment in interface PayInApi

Returns:

Throws:

java.lang.Exception

getRecurringPayment

public RecurringPaymentExtended getRecurringPayment(java.lang.String payInId)
                                             throws java.lang.Exception

Specified by:

getRecurringPayment in interface PayInApi

Returns:

Throws:

java.lang.Exception

updateRecurringPayment

public RecurringPaymentExtended updateRecurringPayment(java.lang.String payInId,
                                                       RecurringPaymentUpdate payIn)
                                                throws java.lang.Exception

Specified by:

updateRecurringPayment in interface PayInApi

Returns:

Throws:

java.lang.Exception

createRecurringPayInCIT

public RecurringPayIn createRecurringPayInCIT(java.lang.String idempotencyKey,
                                              RecurringPayInCIT cit)
                                       throws java.lang.Exception

Specified by:

createRecurringPayInCIT in interface PayInApi

Returns:

Throws:

java.lang.Exception

createRecurringPayInMIT

public RecurringPayIn createRecurringPayInMIT(java.lang.String idempotencyKey,
                                              RecurringPayInMIT mit)
                                       throws java.lang.Exception

Specified by:

createRecurringPayInMIT in interface PayInApi

Returns:

Throws:

java.lang.Exception

get

public PayIn get(java.lang.String payInId)
          throws java.lang.Exception

Description copied from interface: PayInApi

Gets PayIn entity by its identifier.

Specified by:

get in interface PayInApi

Parameters:

payInId - PayIn identifier.

Returns:

PayIn object returned by API.

Throws:

java.lang.Exception

createRefund

public Refund createRefund(java.lang.String payInId,
                           Refund refund)
                    throws java.lang.Exception

Description copied from interface: PayInApi

Creates refund for PayIn object.

Specified by:

createRefund in interface PayInApi

Parameters:

payInId - PayIn identifier.

refund - Refund object to be created.

Returns:

Refund entity instance returned by REST API.

Throws:

java.lang.Exception

createRefund

public Refund createRefund(java.lang.String idempotencyKey,
                           java.lang.String payInId,
                           Refund refund)
                    throws java.lang.Exception

Description copied from interface: PayInApi

Creates refund for PayIn object.

Specified by:

createRefund in interface PayInApi

Parameters:

idempotencyKey - Idempotency key for this request.

payInId - PayIn identifier.

refund - Refund object to be created.

Returns:

Refund entity instance returned by REST API.

Throws:

java.lang.Exception

getRefund

public Refund getRefund(java.lang.String payInId)
                 throws java.lang.Exception

Description copied from interface: PayInApi

Gets refund for PayIn object.

Specified by:

getRefund in interface PayInApi

Parameters:

payInId - PayIn identifier.

Returns:

Refund entity instance returned by REST API.

Throws:

java.lang.Exception

getRefunds

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

Description copied from interface: PayInApi

Get first page of payIn refunds

Specified by:

getRefunds in interface PayInApi

Parameters:

payInId - PayIn identifier

Returns:

Collection of payIn refunds

Throws:

java.lang.Exception

getRefunds

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

Description copied from interface: PayInApi

Get page of payIn refunds

Specified by:

getRefunds in interface PayInApi

Parameters:

payInId - PayIn identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of payIn refunds

Throws:

java.lang.Exception

createCardPreAuthorizedDepositPayIn

public CardPreAuthorizedDepositPayIn createCardPreAuthorizedDepositPayIn(CreateCardPreAuthorizedDepositPayIn payIn,
                                                                         java.lang.String idempotencyKey)
                                                                  throws java.lang.Exception

Specified by:

createCardPreAuthorizedDepositPayIn in interface PayInApi

Throws:

java.lang.Exception

createPayPal

public PayIn createPayPal(PayIn payIn)
                   throws java.lang.Exception

Description copied from interface: PayInApi

Creates new PayPal Web PayIn object.

Specified by:

createPayPal in interface PayInApi

Parameters:

payIn - The PayIn object to be created.

Returns:

Created PayIn object returned by API.

Throws:

java.lang.Exception