Skip to main content

List all transactions data - V2

GET 
/api/v2/transactions

List all transactions data. If no parameter is set, it will automatically select today’s date

 *     as the search parameter.

Request​

Query Parameters

    start_date string

    Filter by created at start date

    end_date string

    Filter by created at end_date

    transaction_type string

    Possible values: [transaction, withdraw, returned, refund]

    Filter by transaction type.

    page string

    Filter by page number

    limit string

    Limit numbers of itens by page

Responses​

Successful operation

Schema
    data object[]

    Array of transactions data)

  • Array [
    • anyOf
    transaction_uuid transaction_uuid (string)

    Reference of the QrCode for conciliation

    status status (string)

    Possible values: [pending, paid, canceled, paid_by_third_party, failed, awaiting, payment rejected, paid_without_qrcode, refund_received]

    Transaction status

    transaction_type transaction_type (string)

    Possible values: [transaction, withdraw, refund]

    Transaction type

    value value (string)

    Value of the transaction

    client_document cpf_cnpj (string)

    Document of the person who paid or received (CPF or CNPJ)

    created_at created_at (string)

    Date when the transaction was created

    merchant_id merchant_id (string)

    Merchant's ID for conciliation

    costumer_name costumer_name (string)

    Costumer's name

    costumer_email costumer_email (string)

    Costumer's email

    end_to_end_id end_to_end_id (string)

    Transaction's pix end_to_end_id

    updated_at updated_at (string)

    Date when the transaction was last updated

    payment_date payment_date (string)

    Date when the transaction was confirmed as paid

  • ]
    • links object

    Links

    first first (string)

    Show first page link

    last last (string)

    Show last page link

    prev prev (string)

    Show previous page link

    next next (string)

    Show next page link

    meta object

    Links

    current_page current_page (integer)

    Current page number

    from from (integer)

    From page number

    last_page last_page (integer)

    Last page number

    links object[]

    Array of links to navigate the pages

  • Array [
    • anyOf
    url url (string)required

    url

    label label (string)required

    label

    active active (boolean)required

    active

  • ]
    • path path (string)

    Pagination path

    per_page per_page (integer)

    Pagination per_page number os itens

    to to (integer)

    Pagination to page

    total total (integer)

    Total number of itens per page

Loading...