Sign in

v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB
Transferências

Criar transferência TED

post/v1/marketplace/banking/transfers/ted

Headers

mTLSstring required

Esta rota requer autenticação mTLS. Você deve enviar seu certificado de cliente (ex: --cert client.crt --key client.key).

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

Request body

first_namestring required

Primeiro nome do recebedor.

last_namestring required

Sobrenome do recebedor.

documentstring required

Documento do recebedor.

phone_numberstring required

Número de telefone do recebedor.

emailstring required

E-mail do recebedor.

Example request

{
  "bank_account": {
    "type": "CHECKING"
  }
}

Response

_idstring required

ID da transferência.

type'TED' | 'P2P' | 'PIX' required

Tipo da transferência.

status'CREATED' | 'PENDING' | 'PAID' | 'FAILED' | 'REFUNDED' | 'CANCELED' | 'PROCESSING' required

Status atual da transferência.

amountnumber required

Valor transferido em centavos.

original_amountnumber

Valor original da transferência em centavos.

establishment_idstring required

ID do estabelecimento.

gateway_keystring

Código do gateway.

gateway_authorizationstring required

Código de autorização do gateway.

expected_atstring date-time required

Data prevista para conclusão da transferência.

method'IN' | 'OUT' required

Direção da transferência (entrada ou saída).

pixKeystring

Chave Pix utilizada (caso aplicável).

end_to_endstring

Identificador único de cada transação.

descriptionstring

Descrição da transferência.

reprocessedboolean required

Indica se a transferência foi reprocessada.

created_atstring date-time required

Data de criação da transferência.

updated_atstring date-time required

Data da última atualização da transferência.

feesnumber

Valor total de taxas da transferência.

Example response

{
  "recipient": {
    "type": "CHECKING"
  },
  "payer": {
    "type": "CHECKING"
  }
}