12. Transferências

A Transferência é uma movimentação de fundos entre uma Conta Moip e outra conta de pagamento (pode ser uma Conta bancária ou uma determinada Conta Moip).

Atributos:

Nome

Descrição

Detalhes

id

Id da transferência.

string,
response

ownId

Id próprio da transferência. Referência externa.

string

fee

fee

integer,
response

amount

Valor a ser transferido (sem a vírgula como separador).

integer

description

Descritivo sobre o motivo da transferência.

string

status

Status da transferência. Valores possíveis: REQUESTED, COMPLETED, FAILED, REVERSED.

string,
response

role

Papel do usuário na transferência. Valores possíveis: PAYER, RECEIVER.

string,
response

transferInstrument

Conta destino.

structured

├─method

Método de transferência. Valores possíveis: BANK_ACCOUNT, MOIP_ACCOUNT

string

├─bankAccount

Conta bancária.

structured

├─├─id

Identificador da conta bancária.

string

├─├─type

Tipo da conta. Valores possíveis: CHECKING, SAVING.

string

├─├─bankNumber

Número do banco (padrão FEBRABAN).Ver lista de bancos e códigos FEBRABAN.

string

├─├─bankName

Nome do banco (padrão FEBRABAN).

string

├─├─agencyNumber

Número da agência.

integer

├─├─agencyCheckNumber

Dígito verificador da agência.

integer

├─├─accountNumber

Número da conta.

integer

├─├─accountCheckNumber

Dígito verificador da conta.

integer

├─├─holder

Titular da conta. Deve ser igual ao titular da conta Moip

structured

├─├─├─fullname

Nome do titular da conta.

string

├─├─├─taxDocument

Documento fiscal do titular.

structured

├─├─├─├─type

Tipo do documento. Valores possíveis: CPF, CNPJ.

string

└─└─└─└─number

Número do documento.

integer

├─moipAccount

Conta Moip

structured

├─├─id

Identificador de conta Moip: Ex. MPA-1A23BC4D5E6F.

string

├─├─login

Login da conta Moip.

string,
response

└─├─fullname

Nome do proprietário da conta Moip.

string,
response

└─└─email

Email principal do proprietário da conta Moip.

string,
response

events

Eventos associados ao pedido.

structured list,
response

├─createdAt

Data de criação do evento.

date(AAAA-MM-DD),
response

├─type

Tipo do evento. Valores possíveis: TRANSFER.REQUESTED, TRANSFER.COMPLETED, TRANSFER.FAILED, TRANSFER.REVERSED.

string,
response

└─description

Descrição do evento.

string(65),
response

cancellationDetails

Detalhes do cancelamento de transferência bancárias.

structured

├─cancelledBy

Responsável pelo cancelamento. Valores possíveis: MOIP ou BANK.

string,
response

├─code

Código do motivo de cancelamento. Valores possíveis: ver lista de detalhes de cancelamento

integer,
response

└─description

Descrição do motivo de cancelamento.

string,
response

createdAt

Data de criação do recurso.

datetime

updatedAt

Data da última atualização do recurso.

datetime

├─self

Hyperlink para o próprio recurso.

structured

└─└─href

URI do próprio recurso.

link