v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Listar transferências

Este endpoint é utilizado para listar as transferências que estão pendentes de aprovação ou rejeição.

get/transfer_requests

Query parameters

q[created_at_gteq]string

Filtra por transferências criadas após uma data e hora específicas no formato: <code>YYYY-MM-DD HH:MM:SS</code>.

q[created_at_lteq]string

Filtra por transferências criadas antes de uma data e hora específicas no formato: <code>YYYY-MM-DD HH:MM:SS</code>.

q[origin_account_cont]string

Filtra por transferências com número de conta de origem que contenha o valor especificado.

q[origin_document_number_eq]string

Filtra por transferências com documento da conta de origem igual ao valor especificado.

q[origin_name_cont]string

Filtra por transferências onde o nome do participante da conta destino contenha o valor especificado.

q[value_lteq]string

Filtra por transferências com valor menor ou igual ao valor especificado.

q[value_gteq]string

Filtra por transferências com valor maior ou igual ao valor especificado.

q[value_eq]string

Filtra por transferências com valor exatamente igual ao valor especificado.

q[destination_document_number_eq]string

Filtra por transferências com documento da conta destino igual ao valor especificado.

q[destination_company_name_cont]string

Filtra por transferências onde a razão social da conta destino contenha o valor especificado.

q[transferMethod]'ted' | 'tef' | 'pix'

Método de transferência.

Response

200

successboolean

messagestring

searchedobject

Example response

{
  "data": [
    {
      "uuid": "0566f190-78d9-4670-9129-3cdf843497e7",
      "api_partner_transaction_uuid": "7bab790a-9149-4277-937f-e87dba64c1b6",
      "origin_bank_account": {
        "agency": "0001",
        "account": "00002024-8",
        "name": "Beneficiário 1"
      },
      "associated_fund": "Fundo Teste",
      "beneficiary": {
        "company_name": "Beneficiário 2",
        "destination_account": {
          "agency": "0001",
          "account": "00002332-5",
          "name": "Grafeno - Cliente 2"
        }
      },
      "transfer_details": {
        "created_at": "2020-06-01T11:39:54.544-03:00",
        "value": "200.0",
        "source": "api"
      }
    }
  ],
  "pagination": {
    "total_pages": 1,
    "current_page": 1,
    "items_per_page": 50,
    "count": 1,
    "total_count": 1
  },
  "success": true,
  "message": "OK"
}