Skip to main content

List TED Received Operations

GET 
/v1/banking/ted/received
Tag: api-baas-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

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires 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_account_type string

    Banking TED Received Owner Account Type.

    owner_bank_account string

    Banking TED Received Owner Bank Account.

    owner_bank_branch string

    Banking TED Received Owner Bank Branch.

    owner_bank_code string

    Banking TED Received Owner Bank Code.

    owner_bank_name string

    Banking TED Received Owner Bank Name.

    created_at date-time

    Banking TED Received Created At.

  • ]
Loading...