v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Retornando transferências

Retorna os dados de todas as transferências previamente realizadas.

get/transfers

Query parameters

countstring

Retorna n resultados, com um máximo de 1000

cursorstring

Útil para implementação de uma paginação de resultados, permitindo a troca de páginas utilizando x-cursor-nextpage ou x-cursor-previouspage.

x-cursor-nextpagestring

Retornado nos headers da resposta contém o Token que permite acesso a próxima página.

x-cursor-previouspagestring

Retornado nos headers da resposta contém o Token que permite acesso a página anterior.

bank_account_idstring

Filtro de bank account id

amountstring

Filtro de amount

recipient_idstring

Filtro de recipient id

idstring

ID da transferência procurada

date_createdstring date

Filtro de data da criação da transferência

created_atstring date

Mesmo que date_created

statusstring

Filtro para um dos status: pending_transfer, transferred, failed, processing, canceled

date_updatedstring date

Filtro para data de último update

Response

200

objectstring

idinteger

amountinteger

typestring

statusstring

source_typestring

source_idstring

target_typestring

target_idstring

feeinteger

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

funding_estimated_datestring

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

date_createdstring

{"stackTrail":"paths:/transfers:get:responses:200:content:application/json:schema:items:properties:bank_response","oasType":"schema","type":"unknown"}

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"
    }
  }
]