12. Transfers

The Transfer is a movement of funds between a Wirecard Account and another payment account (it can be a Bank Account or a specific Wirecard Account).

Atributtes:

Name

Description

Details

id

Transfer id.

string,
response

ownId

Transfer own id.
External reference.

string

fee

Fees.

integer,
response

amount

Value to be transferred (without the comma as a separator).

integer

description

Description of the reason for the transfer.

string

status

Transfer status. Possible values: REQUESTED, COMPLETED, FAILED, REVERSED.

string,
response

role

User role in the transfer. Possible values:PAYER, RECEIVER.

string,
response

transferInstrument

Target account.

structured

├─method

Transfer method.
Possible values: BANK_ACCOUNT, MOIP_ACCOUNT

string

├─bankAccount

Bank account.

structured

├─├─id

Bank account id.

string

├─├─type

Bank account type.
Possible values: CHECKING, SAVING.

string

├─├─bankNumber

Bank number (FEBRABAN code). See the bank list here.

string

├─├─bankName

Bank name (FEBRABAN default).

string

├─├─agencyNumber

Bank agency number.

integer

├─├─agencyCheckNumber

Agency check number.

integer

├─├─accountNumber

Bank account number.

integer

├─├─accountCheckNumber

Account check number.

integer

├─├─holder

Holder of the bank account. Must be the same as the Wirecard account holder

structured

├─├─├─fullname

Holder name.

string

├─├─├─taxDocument

Holder tax document.

structured

├─├─├─├─type

Tax document type.
Possible values: CPF, CNPJ.

string

└─└─└─└─number

Tax document number.

integer

├─moipAccount

Wirecard account.

structured

├─├─id

Wirecard account id.
Ex. MPA-1A23BC4D5E6F.

string

├─├─login

Wirecard account login.

string,
response

└─├─fullname

Name of the owner of the Wirecard account.

string,
response

└─└─email

Primary email of the owner of the Wirecard account.

string,
response

events

Order events.

structured list,
response

├─createdAt

Event creation date.

date(YYYY-MM-DD),
response

├─type

Event type.
Possible values: TRANSFER.REQUESTED, TRANSFER.COMPLETED, TRANSFER.FAILED, TRANSFER.REVERSED.

string,
response

└─description

Event description.

string(65),
response

cancellationDetails

Bank transfer cancellation details.

structured

├─cancelledBy

Responsible for cancellation. Possible values: MOIP ou BANK.

string,
response

├─code

Cancellation reason code. see list of cancellation details.

integer,
response

└─description

Description of the reason for cancellation.

string,
response

createdAt

Resource creation date.

datetime

updatedAt

The date the resource was last updated.

datetime

├─self

Hyperlink to the resource itself.

structured

└─└─href

URI of the resource itself.

link