com.mangopay.core.APIs

Interface PayInApi

All Known Implementing Classes:

PayInApiImpl

public interface PayInApi

Created by thepa on 18-Jan-17.

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 cit)
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)

Method Detail

create

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

Creates new PayIn object.

Parameters:

payIn - The PayIn object to be created.

Returns:

Created PayIn object returned by API.

Throws:

java.lang.Exception

create

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

Creates new PayIn object.

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

get

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

Gets PayIn entity by its identifier.

Parameters:

payInId - PayIn identifier.

Returns:

PayIn object returned by API.

Throws:

java.lang.Exception

createRecurringPayment

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

Parameters:

idempotencyKey -

createRecurringPayment -

Returns:

Throws:

java.lang.Exception

getRecurringPayment

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

Parameters:

payInId -

Returns:

Throws:

java.lang.Exception

updateRecurringPayment

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

Parameters:

payInId -

Returns:

Throws:

java.lang.Exception

createRecurringPayInCIT

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

Parameters:

idempotencyKey -

cit -

Returns:

Throws:

java.lang.Exception

createRecurringPayInMIT

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

Parameters:

idempotencyKey -

cit -

Returns:

Throws:

java.lang.Exception

createRefund

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

Creates refund for PayIn object.

Parameters:

payInId - PayIn identifier.

refund - Refund object to be created.

Returns:

Refund entity instance returned by REST API.

Throws:

java.lang.Exception

createRefund

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

Creates refund for PayIn object.

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

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

Gets refund for PayIn object.

Parameters:

payInId - PayIn identifier.

Returns:

Refund entity instance returned by REST API.

Throws:

java.lang.Exception

getRefunds

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

Get first page of payIn refunds

Parameters:

payInId - PayIn identifier

Returns:

Collection of payIn refunds

Throws:

java.lang.Exception

getRefunds

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

Get page of payIn refunds

Parameters:

payInId - PayIn identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of payIn refunds

Throws:

java.lang.Exception

createCardPreAuthorizedDepositPayIn

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

Throws:

java.lang.Exception

createPayPal

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

Creates new PayPal Web PayIn object.

Parameters:

payIn - The PayIn object to be created.

Returns:

Created PayIn object returned by API.

Throws:

java.lang.Exception