Skip to main content

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​

Banking TED Received.

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.

  • ]
Loading...