List TED Received Operations

GET 
/banking/ted/received

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Tag: api-paas-get-banking-ted-receivedDescription: Retrieve a list of the user's TED (Transferência Eletrônica Disponível) received operations. Use optional filter parameters to refine your search.

Request

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [id, created_at]

Page Sort Attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

owner_document string

Banking TED Received Owner Document.

created_at_start date-time

Created at start for any Banking TED Received.

created_at_end date-time

Created at end for any Banking TED Received.

Header Parameters

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-product-uuid string

The product ID is a UUID (v4) used to identify the Z.ro product configuration.

x-product-target-user-uuid string

The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses

200

Banking TED Received.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
BankingTedsReceived Data.
Array [
id numberrequired
Banking TED Received ID.
operation_id stringrequired
Banking TED Received Operation.
amount numberrequired
Banking TED Received Amount.
owner_name string
Banking TED Received Owner Name.
owner_document string
Banking TED Received Owner Document.
owner_bank_account string
Banking TED Received Owner Bank Account.
owner_bank_branch string
Banking TED Received Owner Bank Branch.
owner_bank_code string
3-digit code used to identify financial institutions, primarily utilized by customers and end users when entering information for transfers. It is different from the ISPB, which is an internal 8-digit code in the Brazilian financial system used for transactions between banks and fintechs.
owner_bank_name string
Banking TED Received Owner Bank Name.
created_at date-time
Banking TED Received Created At.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": 4598,
      "operation_id": "1b43322e-d6d5-4895-ac3f-a440cc63816a",
      "amount": 4598,
      "owner_name": "João",
      "owner_document": "12345678901",
      "owner_bank_account": "12345",
      "owner_bank_branch": "12345",
      "owner_bank_code": "237",
      "owner_bank_name": "Banco Bradesco S.A.",
      "created_at": "2022-01-01T00:00:00.000Z"
    }
  ]
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://docs.zrobank.io/banking/ted/received' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Auth

Bearer Token

Parameters

nonce — headerrequired

page — query

size — query

sort — query

---idcreated_at

order — query

---ascdesc

owner_document — query

created_at_start — query

created_at_end — query

x-lang — header

---pt-BRen-US

x-product-uuid — header

x-product-target-user-uuid — header

ResponseClear

Click the Send API Request button above and see the response here!