Transferências
Obtém detalhes das transferências realizadas com base nos filtros fornecidos.
Required scopes:myeduzz_financial_read
GET
https://api.eduzz.com/myeduzz/v1/financial/transfers
Query params
page
number
Página atual
itemsPerPage
number
Número de itens por página
Response params (200)
pages
number
Número de páginas
page
number
Página atual
itemsPerPage
number
Número máximo de itens por página
totalItems
number
Número total de items
items
array of object
items[n].id
string
Id da transferência
items[n].value
object
Valor da transferência
items[n].value.currency
string
Moeda
items[n].value.value
number
Valor
items[n].requestedAtNullable
datetime
Data de solicitação da transferência
items[n].completedAtNullable
datetime
Data de conclusão da transferência
items[n].createdAt
datetime
Data de criação da transferência
items[n].status
enum
Status da transferência
confirmed
canceled
returnedMessage
pending
awaitingBankReturn
inProgress
blocked
awaitingTransfer
inProcess
inQueue
failed
registeringInvoices
items[n].detailsNullable
string
Detalhes da transferência
items[n].bankAccount
object
Conta bancária de destino da transferência
items[n].bankAccount.typeNullable
enum
Tipo da conta bancária
checkingAccount
savingsAccount
items[n].bankAccount.bankCode
string
Código do banco da conta bancária
items[n].bankAccount.agency
string
Agência da conta bancária
items[n].bankAccount.account
string
Conta da conta bancária
Status codes
| Status | Descrição |
| 200 | Success |
Exemplos
1curl --request GET \
2 --url https://api.eduzz.com/myeduzz/v1/financial/transfers \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json' \
5 --header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'Response
1{
2 "pages": 1,
3 "page": 1,
4 "itemsPerPage": 10,
5 "totalItems": 1,
6 "items": [
7 {
8 "id": "123456",
9 "value": {
10 "currency": "BRL",
11 "value": 1000
12 },
13 "requestedAt": "2021-01-02",
14 "completedAt": "2021-01-02",
15 "createdAt": "2021-01-01",
16 "status": "confirmed",
17 "details": "Transferência realizada com sucesso.",
18 "bankAccount": {
19 "type": "checkingAccount",
20 "bankCode": "001",
21 "agency": "1234",
22 "account": "123456-0"
23 }
24 }
25 ]
26}