Transferir para Outros Bancos
Faz transferências monetárias para outra instituição (TED). Não é permitido realizar uma TED de uma conta Stone para outra conta Stone.
Horário de funcionamento
A API de Transferência Externa fica disponível em dias úteis, das 6h30 às 17h20, a transação é processada de forma assíncrona e o valor é creditado na conta destino em poucas horas.
Caso a transferência seja criada em um dia não útil ou fora do horário de funcionamento de TEDs, a transferência será agendada automaticamente para o dia seguinte. Nesse caso seu status será DELAYED_TO_NEXT_BUSINESS_DAY
, como também a flag delayed_to_next_business_day = true
. O campo scheduled_to_effective
conterá a data para a qual a TED foi agendada.
A transferência também pode ser agendada através do campo scheduled_to
. A data usada no campo scheduled_to
deve estar entre a data next_available_execution_date
e a data limite retornada no campo execution_limit_date
da API de calendário de agendamento chamada com o parâmetro operation_type=external_transfer
. Caso a data escolhida seja menor do que next_available_execution_date
, a transferência será executada imediatamente. Caso a data seja maior que execution_limit_date
será retornado um erro 422.
Caso a data escolhida não seja um dia útil, a transferência será automaticamente agendada para o próximo dia útil depois do escolhido. O dia útil requisitado (que veio na request) e o efetivo (em que de fato o agendamento vai ocorrer) são representados pelos campos scheduled_to_requested
e scheduled_to_effective
.
A data usada no campo scheduled_to
deve obedecer a data limite retornada na API de calendario de agendamento. Caso contrário, será retornado um erro 422 na criação.
POST https://sandbox-api.openbank.stone.com.br/api/v1/external_transfers
BODY PARAMS
amount* int32
Valor da transferência em centavos de Real, ou seja, um real fica 100.
account_id* string
Identificador da conta que está enviando a transferência.
target object
account object
account_code string
(obrigatório)
Número da conta. Padrão: ^[1-9]\d{1,19}$
branch_code string
Número da agência. Padrão: ^\d{1,4}$
institution_code string
(obrigatório)
Código ISPB da instituição ou número do banco. Padrão: ^(\d{8}|\d{3})$
.
account_type string
Tipo de conta destino (verifique mais abaixo os tipos disponíveis).
entity object
name string
(obrigatório)
Nome do dono da conta alvo.
document string
(obrigatório)
Número do documento sem pontos ou caracteres espaciais do dono da conta alvo.
document_type string
Tipo do documento do dono da conta alvo. Pode ser CPF
ou CNPJ
.
scheduled_to string
Formato: yyyy-mm-dd
HEADERS
x-stone-idempotency-key string
Chave de idempotência
Request Body
O corpo da requisição deve conter todos os dados da transferência.
Observe que os “0"s que prefixam o account_code
são removidos. Por exemplo, “00012345” é armazenado como “12345” e vai ser retornado assim nas APIs de consulta.
Essa transformação é aplicada pela API antes dos dados serem armazenados.
Tipos de conta ( target.account.account_type )
Através deste campo, é possível enviar o tipo de conta destino. Os valores aceitos são:
“CC” - Conta Corrente
“CD” - Conta de Depósito
“CG” - Conta garantida
“PG” - Conta de Pagamento
“PP” - Poupança
Este campo possui regras especiais para utilização:
Se o tipo de conta for PG, a agência (branch_code) é removida.
Se o tipo de conta for CC ou nulo, mas o número da conta (account_code) possuir mais de 13 dígitos, o tipo de conta é convertido para PG e a agência (branch_code) é removida.
Se o tipo de conta for CC ou nulo, mas a agência (branch_code) não vier preenchida, o tipo de conta é convertido para PG.
Se o tipo de conta é nulo e não cai nos casos acima, o tipo de conta usado é CC."
Sobre o objeto target
Quando a conta alvo pertence a uma pessoa jurídica, usar CNPJ
ao invés de CPF
no objeto target.entity
."
Agendamento
Em sandbox, a transferência externa está disponível de 6:30 às 17:23 todos os dias.
Em produção, só está habilitada em dias úteis de 6:30 até 17:23. Após este horário a transferência será agendada para o próximo dia útil.",
Response
202 Accepted
content-type: application/json
Body
{
"amount": 100,
"approval_expired_at": null,
"approved_at": "2019-08-02T18:14:34Z",
"approved_by": "user:08807157-f8e1-439e-a2ec-154ecb4bee13",
"cancelled_at": null,
"created_at": "2019-08-02T18:14:34Z",
"created_by": "user:08807157-f8e1-439e-a2ec-154ecb4bee13",
"delayed_to_next_business_day": false,
"failed_at": null,
"failure_reason_code": null,
"failure_reason_description": null,
"fee": 400,
"finished_at": null,
"id": "7458c329-c5e9-4cc8-8174-3aa6210a8867",
"refund_reason_code": null,
"refund_reason_description": null,
"refunded_at": null,
"rejected_at": null,
"rejected_by": null,
"scheduled_to_effective": null,
"scheduled_to_requested": null,
"settled_at": null,
"status": "APPROVED",
"target": {
"account": {
"account_code": "58859",
"branch_code": "1",
"institution_code": "90400888",
"institution_ispb": "90400888",
"institution_name": "Banco Santander (Brasil) S. A.",
"institution_number_code": "033"
},
"entity": {
"cpf": "62752545053",
"document": "62752545053",
"document_type": "cpf",
"name": "Octacilio Impoluto"
}
}
}