Transfer class abstract

Transfer

Properties:

  • accountHolder - The account holder associated with the balance account involved in the transfer.
  • amount - The amount of the transfer.
  • balanceAccount - Contains information about the balance account involved in the transfer.
  • 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.
  • categoryData
  • counterparty - The other party in the transfer.
  • createdAt - The date and time when the transfer was created, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.
  • creationDate - The date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.
  • 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 & $ % # @ ~ = + - _ ' " ! ?
  • directDebitInformation - The details of the direct debit.
  • direction - The direction of the transfer. Possible values: incoming, outgoing.
  • executionDate - Contains information about the date when the transfer will be processed. The execution date must be within 30 days of the current date. Until the execution date: - The status of the transfer remains as received. - The reason of the transfer remains as pending.
  • id - The ID of the resource.
  • paymentInstrument - Contains information about the payment instrument used in the transfer.
  • reason - Additional information about the status of the transfer.
  • 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 the source and recipient of funds. 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 status updates related to additional reviews.
  • status - The result of the transfer. For example: - received: an outgoing transfer request is created. - refused: the transfer request is rejected by Adyen for one of the following reasons: - Lack of funds in the balance account. - Transfer limit exceeded. - Transaction rule requirements violated. - authorised: the transfer request is authorized and the funds are reserved. - booked: the funds are deducted from your user's balance account. - failed: the transfer is rejected by the counterparty's bank. - returned: the transfer is returned by the counterparty's bank.
  • type - The type of transfer or transaction. For example, refund, payment, internalTransfer, bankTransfer.
Annotations
  • @BuiltValue.new()

Constructors

Transfer([void updates(TransferBuilder b)])
factory

Properties

accountHolder → ResourceReference?
The account holder associated with the balance account involved in the transfer.
no setter
amount → Amount
The amount of the transfer.
no setter
balanceAccount → ResourceReference?
Contains information about the balance account involved in the transfer.
no setter
category → TransferCategoryEnum
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
categoryData → TransferCategoryData?
no setter
counterparty → CounterpartyV3
The other party in the transfer.
no setter
createdAt → DateTime?
The date and time when the transfer was created, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.
no setter
creationDate → DateTime?
The date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.
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
directDebitInformation → DirectDebitInformation?
The details of the direct debit.
no setter
direction → TransferDirectionEnum?
The direction of the transfer. Possible values: incoming, outgoing.
no setter
executionDate → ExecutionDate?
Contains information about the date when the transfer will be processed. The execution date must be within 30 days of the current date. Until the execution date: - 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
id → String?
The ID of the resource.
no setter
paymentInstrument → PaymentInstrument?
Contains information about the payment instrument used in the transfer.
no setter
reason → TransferReasonEnum?
Additional information about the status of the transfer.
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 the source and recipient of funds. 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 → TransferReview?
Contains status updates related to additional reviews.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → TransferStatusEnum
The result of the transfer. For example: - received: an outgoing transfer request is created. - refused: the transfer request is rejected by Adyen for one of the following reasons: - Lack of funds in the balance account. - Transfer limit exceeded. - Transaction rule requirements violated. - authorised: the transfer request is authorized and the funds are reserved. - booked: the funds are deducted from your user's balance account. - failed: the transfer is rejected by the counterparty's bank. - returned: the transfer is returned by the counterparty's bank.
no setter
type → TransferTypeEnum?
The type of transfer or transaction. For example, refund, payment, internalTransfer, bankTransfer.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(TransferBuilder)) → Transfer
Rebuilds the instance.
inherited
toBuilder() → TransferBuilder
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<Transfer>
no setter