Transfers

O acesso à API de transferências é realizado através de requisições para os endpoints que ramificam do endpoint base /v1/companies/{companyId}/transfers. As páginas que detalham cada operação indicarão se há a possibilidade de filtragem por meio de query paramethers e quais serão esses parametros.

EndpointDescriçãoVerbos
/v1/companies/{companyId}/transfersInicia e lista transferênciasPOST, GET
/companies/{companyId}/transfers/scheduleObtém a lista de transferências agendadasGET
/v1/companies/{companyId}/transfers/approvals/{approvalId}Cancela uma pendência por um Id.DELETE
v1/companies/{companyId}/transfers/approvalsObtém a lista de transferências pendentes de aprovação.GET
v1/companies/{companyId}/transfers/{transferId}Cancela e lista uma transferência especificaDELETE, GET
v1/companies/{companyId}/transfers/{transferId}/receiptObtém o PDF do comprovante em base64GET

Corpo da transferência

CampoTipoDescrição
amountnumberQuantia a ser transferida
scheduledDateDateData de agendamento
reasonstringMensagem do comprovante
typestringTipo de transferência
debitPartyobjectParte debitada
creditPartyobjectParte creditada
tagsobjectTag

Objeto debitParty

CampoTipoDescrição
branchCodestringCódigo identificador do banco
numberstringNúmero da parte debitada

Objeto creditParty

CampoTipoDescrição
accountDataobjectDados da conta creditada
pixDataobjectInformações de pix caso seja usado

Objeto accountData

CampoTipoDescrição
bankCodestringCÓdigo bancario
branchCodestringCódigo identificador do banco
numberstringNúmero
accountTypestringTipo da conta
taxIdstring
namestringNome da conta

Objeto pixData

CampoTipoDescrição
keyTypestringTipo da chave pix
pixKeystringChave pix

Objeto tags

CampoTipoDescrição
externalIdstringIdentificador da transação