Package io.token.sdk.api

Class BulkTransferRequest

java.lang.Object

io.token.sdk.api.BulkTransferRequest

public abstract class BulkTransferRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkTransferRequest.Builder
static class	BulkTransferRequest.Transfer

Constructor Summary

Constructors

Constructor	Description
BulkTransferRequest()

Method Summary

Modifier and Type	Method	Description
abstract io.token.proto.common.account.AccountProtos.BankAccount	getAccount()	Returns bank account of the payer.
abstract java.lang.String	getConsentId()	Returns the consent id for this bulk transfer.
abstract java.lang.String	getDescription()	Returns Token bulk transfer description.
abstract java.lang.String	getRefId()	Returns a reference ID for the bulk transfer.
abstract java.lang.String	getTokenBulkTransferId()	Returns Token bulk transfer ID for the bulk transfer.
abstract java.lang.String	getTokenInitiatorId()	Returns token initiator ID, the member ID of the initiator, who initiated the bulk transfer request and set the ref ID.
abstract java.math.BigDecimal	getTotalAmount()	Returns the total transfer amount (regardless of currency).
abstract java.util.List<BulkTransferRequest.Transfer>	getTransfers()	Returns the list of transfers.
static BulkTransferRequest.Builder	newBuilder()	Returns a new transfer builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkTransferRequest

public BulkTransferRequest()

Method Detail

newBuilder

public static BulkTransferRequest.Builder newBuilder()

Returns a new transfer builder.

Returns:

a builder

getTokenBulkTransferId

public abstract java.lang.String getTokenBulkTransferId()

Returns Token bulk transfer ID for the bulk transfer. Token OS generated this ID.

Returns:

token bulk transfer ID

getConsentId

public abstract java.lang.String getConsentId()

Returns the consent id for this bulk transfer. Token OS generated this id.

Returns:

consent id

getRefId

public abstract java.lang.String getRefId()

Returns a reference ID for the bulk transfer. This is the same reference ID on the bulk transfer token. This value is set by the initiator, e.g. a merchant.

Returns:

token reference ID

getTokenInitiatorId

public abstract java.lang.String getTokenInitiatorId()

Returns token initiator ID, the member ID of the initiator, who initiated the bulk transfer request and set the ref ID. This is the same value as initiator_id on the bulk transfer token payload.

Returns:

token initiator ID

getTransfers

public abstract java.util.List<BulkTransferRequest.Transfer> getTransfers()

Returns the list of transfers.

Returns:

transfers list

getTotalAmount

public abstract java.math.BigDecimal getTotalAmount()

Returns the total transfer amount (regardless of currency).

Returns:

total transfer amount

getAccount

public abstract io.token.proto.common.account.AccountProtos.BankAccount getAccount()

Returns bank account of the payer.

Returns:

bank account

getDescription

public abstract java.lang.String getDescription()

Returns Token bulk transfer description.

Returns:

bulk transfer description