v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Listar Saques/Transferência Próprias

Retorna a lista de todas as transferências bancárias.

get/withdraw_requests

Query parameters

custom_variables_namestring

Filtra as transferências bancárias pelo nome da variável customizada

custom_variables_valuestring

Filtra as transferências bancárias pelo valor da variável customizada

statusstring

Status dos saques. Utilizado somente para "Saques". Por padrão, todos os tipos de saques são considerados: pending, processing, accepted, rejected, inconsistent, refunded, partially_refunded, reprocessing.

Response

200

totalItemsinteger

Example response

{
  "items": [
    {
      "id": "4194D625A1894FAFAB2478DC333DAF0D",
      "status": "rejected",
      "created_at": "2024-06-13T09:10:55-03:00",
      "updated_at": "2024-06-14T10:11:03-03:00",
      "reference": "core:transfer:17ctElpMA77H9gJvWtexma",
      "feedback": "Código: '2' - Agência ou Conta Destinatária do Crédito Inválida",
      "paying_at": "2024-06-14",
      "amount": "R$ 5,00",
      "account_name": "Nome da Conta",
      "account_id": "44C5DC6376804D1FA792CBCA382105C1",
      "receipt_url": "https://comprovantes.iugu.com/4194d625-a189-4faf-ab24-78dc333daf0d-d94ba",
      "bank_address": {
        "bank": "Santander",
        "bank_cc": "01010-1",
        "bank_ag": "0003",
        "account_type": "Corrente"
      }
    }
  ],
  "totalItems": 2
}