com.mangopay.core.APIs

Interface TransferApi

All Known Implementing Classes:

TransferApiImpl

public interface TransferApi

Created by thepa on 18-Jan-17.

Method Summary

Modifier and Type	Method and Description
Transfer	create(java.lang.String idempotencyKey, Transfer transfer) Creates new transfer.
Transfer	create(Transfer transfer) Creates new transfer.
Refund	createRefund(java.lang.String transferId, Refund refund) Creates refund for transfer object.
Refund	createRefund(java.lang.String idempotencyKey, java.lang.String transferId, Refund refund) Creates refund for transfer object.
Transfer	get(java.lang.String transferId) Gets the transfer.
Refund	getRefund(java.lang.String transferId) Gets refund for transfer object.
java.util.List<Refund>	getRefunds(java.lang.String transferId) Get first page of transfer's refunds
java.util.List<Refund>	getRefunds(java.lang.String transferId, Pagination pagination, Sorting sorting) Get a page of transfer's refunds

Method Detail

create

Transfer create(Transfer transfer)
         throws java.lang.Exception

Creates new transfer.

Parameters:

transfer - Instance of Transfer class to be created.

Returns:

Transfer object returned from API.

Throws:

java.lang.Exception

create

Transfer create(java.lang.String idempotencyKey,
                Transfer transfer)
         throws java.lang.Exception

Creates new transfer.

Parameters:

idempotencyKey - idempotency key for this request.

transfer - Instance of Transfer class to be created.

Returns:

Transfer object returned from API.

Throws:

java.lang.Exception

get

Transfer get(java.lang.String transferId)
      throws java.lang.Exception

Gets the transfer.

Parameters:

transferId - Transfer identifier.

Returns:

Transfer instance returned from API.

Throws:

java.lang.Exception

createRefund

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

Creates refund for transfer object.

Parameters:

transferId - Transfer identifier.

refund - Refund object to create.

Returns:

Refund entity instance returned from API.

Throws:

java.lang.Exception

createRefund

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

Creates refund for transfer object.

Parameters:

idempotencyKey - idempotency key for this request.

transferId - Transfer identifier.

refund - Refund object to create.

Returns:

Refund entity instance returned from API.

Throws:

java.lang.Exception

getRefund

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

Gets refund for transfer object.

Parameters:

transferId - Transfer identifier.

Returns:

Refund entity instance returned from API.

Throws:

java.lang.Exception

getRefunds

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

Get first page of transfer's refunds

Parameters:

transferId - Transfer identifier

Returns:

Collection of transfer refunds

Throws:

java.lang.Exception

getRefunds

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

Get a page of transfer's refunds

Parameters:

transferId - Transfer identifier

pagination - Pagination object

sorting - Sorting object

Returns:

Collection of refunds

Throws:

java.lang.Exception