Collecting document refund

Events that belongs to the category collecting_document_refund.

Type	Description
created	A collecting document refund was created. This happens when Refund endpoint is used.
settled	A collecting document refund was successfully settled and registered in our ledger.
failed	A collecting document refund has failed due to an error.

Examples

collecting_document_refund.created

{
  "category": "collecting_document_refund",
  "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f6",
  "data": {
    "amount": {
      "amount": 9300,
      "currency": "BRL"
    },
    "attempt": 0,
    "bank_account_id": "0189b787-efb6-2650-7baa-00ba98c4daf1",
    "collecting_document_id": "018de55d-c349-1104-e805-ad9bb798b1f0",
    "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
    "description": "Estorno",
    "end_to_end_id": null,
    "entity_id": "0189b5b4-ea58-a3a8-7c40-f0de1d0cb0af",
    "error_message": null,
    "external_id": "9fa7b90ac41147a2a2225a1e71fe6f8d",
    "id": "018de55d-eac2-379e-4094-2f0e7b2ba72a",
    "origin_id": "018c407f-eb08-006e-805f-4a3d504f2ead",
    "origin_type": "api_client",
    "receipt_url": null,
    "reconciliation_id": "018de55d-eac2-738e-d7d6-e5678ce72bfa",
    "rule": "manual",
    "transaction_date": "2024-02-26T12:22:33.922605Z",
    "virtual_account_id": "0189b787-efc8-b0f5-8171-781814fac2a6"
  },
  "ref_id": "018de55d-eac2-379e-4094-2f0e7b2ba72a",
  "timestamp": "2024-02-26T12:22:33.983939Z",
  "type": "created"
}

collecting_document_refund.settled

{
  "category": "collecting_document_refund",
  "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
  "data": {
    "collecting_document_id": "018de55d-8579-df9a-95da-9a3f05ed0adc",
    "end_to_end_id": "D1320335420240226122217611378645",
    "error_message": null,
    "external_id": "21abe99cb79345e3a2fd2cf79c5bd707",
    "id": "018de55d-daf9-5910-95fa-fc0d67e6c3c5",
    "receipt_url": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=20234-02-26/p0nj5ksw.pdf",
    "refund_document_id": "018de55d-9c6f-46d5-d651-bb186cde3df5",
    "rule": "manual",
    "timestamp": "2024-02-26T12:22:29.881248Z",
    "type": "settled"
  },
  "ref_id": "018de55d-9c6f-46d5-d651-bb186cde3df5",
  "timestamp": "2024-02-26T12:22:30.270215Z",
  "type": "settled"
}

collecting_document_refund.failed

{
  "category": "collecting_document_refund",
  "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f4",
  "data": {
    "collecting_document_id": "018de322-4ac9-b634-d5c8-cd649fe331a5",
    "end_to_end_id": "D1320335420240226020054422416068",
    "error_message": null,
    "external_id": "79d6f5e65ec24ea39b3dd36ad15eccc9",
    "id": "018de325-6bc8-0b18-8cc1-41c7e1640470",
    "receipt_url": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2023-02-25/1um4du5h.pdf",
    "refund_document_id": "018de322-8a16-a2b5-0635-8f4295486712",
    "rule": "manual",
    "timestamp": "2024-02-26T02:01:36.968922Z",
    "type": "reversed"
  },
  "ref_id": "018de322-8a16-a2b5-0635-8f4295486712",
  "timestamp": "2024-02-26T02:01:37.030499Z",
  "type": "failed"
}