TransferInfo class abstract

TransferInfo

Properties:

  • amount - The amount of the transfer.
  • balanceAccountId - The unique identifier of the source balance account. If you want to make a transfer using a virtual bankAccount assigned to the balance account, you must specify the payment instrument ID of the virtual bankAccount. If you only specify a balance account ID, Adyen uses the default physical bankAccount payment instrument assigned to the balance account.
  • category - The category of the transfer. Possible values: - bank: A transfer involving a transfer instrument or a bank account. - card: A transfer involving a third-party card. - internal: A transfer between balance accounts within your platform. - issuedCard: A transfer initiated by an Adyen-issued card. - platformPayment: Funds movements related to payments that are acquired for your users. - topUp: An incoming transfer initiated by your user to top up their balance account.
  • counterparty - The other party involved in the funds transfer. A bank account, a balance account, a card, or a transfer instrument is required.
  • description - Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: a-z A-Z 0-9 / - ? : ( ) . , ' + Space Supported characters for regular and fast transfers to a US counterparty: a-z A-Z 0-9 & $ % # @ ~ = + - _ ' " ! ?
  • executionDate - The date when the transfer will be processed. This date must be within 30 days of the current date. Until the executionDate: - The status of the transfer remains as received. - The reason of the transfer remains as pending.
  • paymentInstrumentId - The unique identifier of the source payment instrument. If you want to make a transfer using a virtual bankAccount, you must specify the payment instrument ID of the virtual bankAccount. If you only specify a balance account ID, Adyen uses the default physical bankAccount payment instrument assigned to the balance account.
  • priorities - The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority you list first. If that's not possible, it moves on to the next option in the order of your provided priorities. Possible values: * regular: For normal, low-value transactions. * fast: A faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * wire: The fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * instant: For instant funds transfers within the United States and in SEPA locations. * crossBorder: For high-value transfers to a recipient in a different country. * internal: For transfers to an Adyen-issued business bank account (by bank account number/IBAN). Required for transfers with category bank. For more details, see fallback priorities.
  • priority - The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with category bank. Possible values: * regular: For normal, low-value transactions. * fast: A faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * wire: The fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * instant: For instant funds transfers within the United States and in SEPA locations. * crossBorder: For high-value transfers to a recipient in a different country. * internal: For transfers to an Adyen-issued business bank account (by bank account number/IBAN).
  • reference - Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.
  • referenceForBeneficiary - A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement. Supported characters: a-z, A-Z, 0-9. The maximum length depends on the category. - internal: 80 characters - bank: 35 characters when transferring to an IBAN, 15 characters for others.
  • review - Contains information required for triggering transfer reviews.
  • type - The type of transfer. Possible values: - bankTransfer: for push transfers to a transfer instrument or a bank account. The category must be bank. - internalTransfer: for push transfers between balance accounts. The category must be internal. - internalDirectDebit: for pull transfers (direct debits) between balance accounts. The category must be internal.
  • ultimateParty - The ultimate sender of the funds of the transfer (ultimate debtor).
Annotations
  • @BuiltValue.new()

Constructors

TransferInfo([void updates(TransferInfoBuilder b)])
factory

Properties

amount → Amount
The amount of the transfer.
no setter
balanceAccountId → String?
The unique identifier of the source balance account. If you want to make a transfer using a virtual bankAccount assigned to the balance account, you must specify the payment instrument ID of the virtual bankAccount. If you only specify a balance account ID, Adyen uses the default physical bankAccount payment instrument assigned to the balance account.
no setter
category → TransferInfoCategoryEnum
The category of the transfer. Possible values: - bank: A transfer involving a transfer instrument or a bank account. - card: A transfer involving a third-party card. - internal: A transfer between balance accounts within your platform. - issuedCard: A transfer initiated by an Adyen-issued card. - platformPayment: Funds movements related to payments that are acquired for your users. - topUp: An incoming transfer initiated by your user to top up their balance account.
no setter
counterparty → CounterpartyInfoV3
The other party involved in the funds transfer. A bank account, a balance account, a card, or a transfer instrument is required.
no setter
description → String?
Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: a-z A-Z 0-9 / - ? : ( ) . , ' + Space Supported characters for regular and fast transfers to a US counterparty: a-z A-Z 0-9 & $ % # @ ~ = + - _ ' " ! ?
no setter
executionDate → ExecutionDate?
The date when the transfer will be processed. This date must be within 30 days of the current date. Until the executionDate: - The status of the transfer remains as received. - The reason of the transfer remains as pending.
no setter
hashCode → int
The hash code for this object.
no setterinherited
paymentInstrumentId → String?
The unique identifier of the source payment instrument. If you want to make a transfer using a virtual bankAccount, you must specify the payment instrument ID of the virtual bankAccount. If you only specify a balance account ID, Adyen uses the default physical bankAccount payment instrument assigned to the balance account.
no setter
priorities → BuiltList<TransferInfoPrioritiesEnum>?
The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority you list first. If that's not possible, it moves on to the next option in the order of your provided priorities. Possible values: * regular: For normal, low-value transactions. * fast: A faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * wire: The fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * instant: For instant funds transfers within the United States and in SEPA locations. * crossBorder: For high-value transfers to a recipient in a different country. * internal: For transfers to an Adyen-issued business bank account (by bank account number/IBAN). Required for transfers with category bank. For more details, see fallback priorities.
no setter
priority → TransferInfoPriorityEnum?
The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with category bank. Possible values: * regular: For normal, low-value transactions. * fast: A faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * wire: The fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * instant: For instant funds transfers within the United States and in SEPA locations. * crossBorder: For high-value transfers to a recipient in a different country. * internal: For transfers to an Adyen-issued business bank account (by bank account number/IBAN).
no setter
reference → String?
Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.
no setter
referenceForBeneficiary → String?
A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement. Supported characters: a-z, A-Z, 0-9. The maximum length depends on the category. - internal: 80 characters - bank: 35 characters when transferring to an IBAN, 15 characters for others.
no setter
review → TransferRequestReview?
Contains information required for triggering transfer reviews.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → TransferInfoTypeEnum?
The type of transfer. Possible values: - bankTransfer: for push transfers to a transfer instrument or a bank account. The category must be bank. - internalTransfer: for push transfers between balance accounts. The category must be internal. - internalDirectDebit: for pull transfers (direct debits) between balance accounts. The category must be internal.
no setter
ultimateParty → UltimatePartyIdentification?
The ultimate sender of the funds of the transfer (ultimate debtor).
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(TransferInfoBuilder)) → TransferInfo
Rebuilds the instance.
inherited
toBuilder() → TransferInfoBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<TransferInfo>
no setter