v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Criando uma transferência

Realiza uma transferência para uma conta bancária previamente criada.

post/transfers

Headers

Idempotency-Keystring

Valor único que identifica a transação para permitir uma nova tentativa de requisição com a segurança de que a mesma operação não será executada duas vezes acidentalmente.

Request body

amountinteger required

Valor, em centavos, a ser transferido para uma determinada conta bancária (valor precisa estar entre 1 e 2147483647)

recipient_idstring

Indica que o valor da transferência sairá da conta do recebedor identificado por este parâmetro. OBS: Caso o recipient_id seja passado, não é necessário passar bank_account_id

metadatastring json

Você pode passar dados adicionais na criação da transferência para facilitar uma futura análise de dados por seus sistemas.

Response

200

objectstring

idinteger

amountinteger

typestring

statusstring

source_typestring

source_idstring

target_typestring

target_idstring

feeinteger

{"stackTrail":"paths:/transfers:post:responses:200:content:application/json:schema:properties:funding_date","oasType":"schema","type":"unknown"}

funding_estimated_datestring

{"stackTrail":"paths:/transfers:post:responses:200:content:application/json:schema:properties:transaction_id","oasType":"schema","type":"unknown"}

date_createdstring

Example response

{
  "object": "transfer",
  "id": 65485,
  "amount": 100,
  "type": "ted",
  "status": "pending_transfer",
  "source_type": "recipient",
  "source_id": "re_cix7pxz6f02ppcv6dn4ckcrcc",
  "target_type": "bank_account",
  "target_id": "17346045",
  "fee": 367,
  "funding_estimated_date": "2017-02-18T02:00:00.000Z",
  "date_created": "2017-02-17T16:24:20.933Z",
  "bank_account": {
    "object": "bank_account",
    "id": 17346045,
    "bank_code": "000",
    "agencia": "00000",
    "agencia_dv": "2",
    "conta": "00000",
    "conta_dv": "00",
    "type": "conta_corrente",
    "document_type": "cpf",
    "document_number": "03602396681",
    "legal_name": "nome2",
    "charge_transfer_fees": true,
    "date_created": "2016-12-27T22:08:10.536Z"
  },
  "metadata": {
    "idProduto": "13933139"
  }
}