Payment document

Events that belongs to the category payment_document.

Type	Description
created	A payment document has been created.
failed	A payment document was sent and not processed due to invalid information.
reversed	A payment document was sent and not processed or declined by the bank.
settled	A payment document was confirmed and successfully registered in our ledger.
refunded	A payment document was successfully refunded.

Examples

payment_document.created

{
  "category": "payment_document",
  "company_id": "0189b5ad-8076-6b61-e299-9920d839a3fc",
  "data": {
    "amount": {
      "amount": 3500,
      "currency": "BRL"
    },
    "bank_account_id": "0189b787-efb6-2650-7baa-00ba98c4daf3",
    "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f5",
    "counterparty": {
      "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
      "external_id": null,
      "id": "018cf863-590a-d49e-50ac-16cf703d62ab",
      "inserted_at": "2024-01-11T11:58:29.642747Z",
      "ledger_type": "customer",
      "legal_name": null,
      "maximum_amount": null,
      "maximum_transactions": null,
      "name": "SANDRA REGINA MOREIRA",
      "tax_number": "00000000000",
      "updated_at": "2024-01-11T11:58:29.642747Z"
    },
    "counterparty_bank_account": {
      "account_digit": "3",
      "account_number": "9246496",
      "account_type": "payment",
      "bank_ispb": "18236120",
      "bank_number": "260",
      "branch": "0001",
      "id": "018d1c49-fd70-4583-c38a-bca45ed65394",
      "inserted_at": "2024-01-18T11:17:07.568871Z",
      "updated_at": "2024-01-18T11:17:07.568871Z"
    },
    "counterparty_bank_account_id": "018d1c49-fd70-4583-c38a-bca45ed65394",
    "counterparty_id": "018cf863-590a-d49e-50ac-16cf703d62ab",
    "description": null,
    "end_to_end_id": null,
    "entity_id": "0189b5b4-ea58-a3a8-7c40-f0de1d0cb0af",
    "error_code": null,
    "error_message": null,
    "external_id": "148e94cf-4f68-4d9d-829f-18d895ae96b6",
    "id": "018de55d-f91c-69e0-846c-a4a89f66c6a8",
    "origin_id": "018c4685-200e-f7ac-761f-ebb6449bb5e5",
    "origin_type": "api_client",
    "payment_date": null,
    "pix_key": "05657560604",
    "receipt_url": null,
    "reconciliation_id": "018de55d-f91c-236d-eb54-f3624ba67009",
    "ref_id": "018d1c49-fd70-4583-c38a-bca45ed65394",
    "ref_type": "bank_account",
    "status": "created",
    "transaction_date": "2024-02-26T12:22:37.596939Z",
    "type": "pix",
    "virtual_account_id": "0189b787-efc8-b0f5-8171-781814fac2a6",
    "without_fee_and_tax": false
  },
  "ref_id": "018de55d-f91c-69e0-846c-a4a89f66c6a8",
  "timestamp": "2024-02-26T12:22:37.872710Z",
  "type": "created"
}

payment_document.failed

{
  "category": "payment_document",
  "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
  "data": {
    "amount": {
      "amount": 30000,
      "currency": "BRL"
    },
    "bank_account_id": "0189b787-efb6-2650-7baa-00ba98c4daf1",
    "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
    "counterparty": {
      "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
      "external_id": null,
      "id": "018d1e1c-a729-6400-2394-c0357f172c90",
      "inserted_at": "2024-01-18T19:46:50.793890Z",
      "ledger_type": "customer",
      "legal_name": null,
      "maximum_amount": null,
      "maximum_transactions": null,
      "name": "ADRIANA ALVES MONTEIRO",
      "tax_number": "75204843191",
      "updated_at": "2024-01-18T19:46:50.793890Z"
    },
    "counterparty_bank_account": {
      "account_digit": "8",
      "account_number": "102832833",
      "account_type": "payment",
      "bank_ispb": "22896431",
      "bank_number": "380",
      "branch": "0001",
      "id": "018de55d-08b6-caef-ed1f-faf059888a5f",
      "inserted_at": "2024-02-26T12:21:36.054258Z",
      "updated_at": "2024-02-26T12:21:36.054258Z"
    },
    "counterparty_bank_account_id": "018de55d-08b6-caef-ed1f-faf059888a5f",
    "counterparty_id": "018d1e1c-a729-6400-2394-c0357f172c90",
    "description": null,
    "end_to_end_id": null,
    "entity_id": "0189b5b4-ea58-a3a8-7c40-f0de1d0cb0af",
    "error_code": "DICT_KEY_DIFFERENT_TAX_NUMBER",
    "error_message": "Tax number da chave é diferente do tax number enviado como referência",
    "external_id": "3293bf68-8e03-40a3-8d72-fb66ac65fdf6",
    "id": "018de55c-f8bf-c145-f9b6-b177a3d82267",
    "origin_id": "018c4685-200e-f7ac-761f-ebb6449bb5e5",
    "origin_type": "api_client",
    "payment_date": null,
    "pix_key": "+5562993308087",
    "receipt_url": null,
    "reconciliation_id": "018de55c-f8bf-18ef-41b6-7b978420d86b",
    "ref_id": "018de55d-08b7-d770-7147-c6ef3e8ce0c6",
    "ref_type": "pix_key",
    "status": "waiting_analysis",
    "transaction_date": "2024-02-26T12:21:31.967284Z",
    "type": "pix",
    "virtual_account_id": "0189b787-efc8-b0f5-8171-781814fac2a6",
    "without_fee_and_tax": false
  },
  "ref_id": "018de55c-f8bf-c145-f9b6-b177a3d82267",
  "timestamp": "2024-02-26T12:21:36.335699Z",
  "type": "failed"
}

payment_document.reversed

{
  "category": "payment_document",
  "company_id": "0189b5ad-8076-6b61-e299-9920d819a3fc",
  "data": {
    "counterparty": {
      "company_id": "0189b5ad-8076-6b61-e299-9920d819a3fc",
      "external_id": null,
      "id": "018d812a-8a01-9911-f177-538c363f3e75",
      "inserted_at": "2024-02-07T01:24:25.217730Z",
      "ledger_type": "customer",
      "legal_name": null,
      "maximum_amount": null,
      "maximum_transactions": null,
      "name": "DANILO GERALDO",
      "tax_number": "00000000000",
      "updated_at": "2024-02-07T01:24:25.217730Z"
    },
    "counterparty_bank_account": {
      "account_digit": "8",
      "account_number": "1441212",
      "account_type": "payment",
      "bank_ispb": "34878543",
      "bank_number": "ID023",
      "branch": "0001",
      "id": "018de555-47a6-5083-6316-3619c928e2cf",
      "inserted_at": "2024-02-26T12:13:07.878089Z",
      "updated_at": "2024-02-26T12:13:07.878089Z"
    },
    "counterparty_bank_account_id": "018de555-47a6-5083-6316-3619c928e2cf",
    "counterparty_id": "018d812a-8a01-9911-f177-538c363f3e75",
    "end_to_end_id": "E1320335420240226121307765412425",
    "error_code": "SPI0001",
    "error_message": "Ocorreu um erro ao processar a transação PIX",
    "external_id": "5cf47f10-7f52-4b9a-b35d-529ba30794e6",
    "id": "018de555-6969-33df-b0ef-ca017e263462",
    "integration_status": "Cancel",
    "payment_document_id": "018de555-3b81-c799-0862-5f31d1d4bc21",
    "receipt_url": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2024-02-26/vrjgpbhd.pdf",
    "timestamp": "2024-02-26T12:13:16.521593Z",
    "type": "reversed"
  },
  "ref_id": "018de555-3b81-c799-0862-5f31d1d4bc21",
  "timestamp": "2024-02-26T12:13:16.679759Z",
  "type": "reversed"
}

payment_document.settled

{
  "category": "payment_document",
  "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
  "data": {
    "counterparty": {
      "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
      "external_id": null,
      "id": "018c630b-88cb-ea0a-1528-36a7d1e7da1d",
      "inserted_at": "2023-12-13T11:59:09.516717Z",
      "ledger_type": "vendor",
      "legal_name": null,
      "maximum_amount": null,
      "maximum_transactions": null,
      "name": "TALITA SANTOS",
      "tax_number": "00000000000",
      "updated_at": "2023-12-13T11:59:09.516717Z"
    },
    "counterparty_bank_account": {
      "account_digit": "8",
      "account_number": "16982166",
      "account_type": "payment",
      "bank_ispb": "22896431",
      "bank_number": "380",
      "branch": "0001",
      "id": "018c630b-88ce-1f91-5d0a-299341e2d98a",
      "inserted_at": "2023-12-13T11:59:09.518285Z",
      "updated_at": "2023-12-13T11:59:09.518285Z"
    },
    "counterparty_bank_account_id": "018c630b-88ce-1f91-5d0a-299341e2d98a",
    "counterparty_id": "018c630b-88cb-ea0a-1528-36a7d1e7da1d",
    "end_to_end_id": "E132033542024022612223FD233CAC63",
    "error_code": null,
    "error_message": null,
    "external_id": "e994bea2-97db-4467-9428-88c3f558389e",
    "id": "018de55d-f3d9-1e3f-e317-804b30faa568",
    "integration_status": "Paid",
    "payment_document_id": "018de55d-d778-18bb-3060-ed63d538ecf7",
    "receipt_url": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2023-02-26/yzxs2eco.pdf",
    "timestamp": "2024-02-26T12:22:36.249593Z",
    "type": "settled"
  },
  "ref_id": "018de55d-d778-18bb-3060-ed63d538ecf7",
  "timestamp": "2024-02-26T12:22:36.542645Z",
  "type": "settled"
}

payment_document.refunded

{
  "category": "payment_document",
  "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
  "data": {
    "amount": {
      "amount": 24000,
      "currency": "BRL"
    },
    "bank_account_id": "0189b787-efb6-2650-7baa-00ba98c4daf1",
    "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
    "counterparty": {
      "company_id": "0189b5ad-8076-6b61-e299-9920d819a3f8",
      "external_id": null,
      "id": "018dd232-3e22-2f81-768b-27b060cd37c7",
      "inserted_at": "2024-02-22T19:02:04.580605Z",
      "ledger_type": "vendor",
      "legal_name": null,
      "maximum_amount": null,
      "maximum_transactions": null,
      "name": "Gustavo Henrique Martins Da Mata",
      "tax_number": "80531369587",
      "updated_at": "2024-02-22T19:02:04.580605Z"
    },
    "counterparty_bank_account": {
      "account_digit": "4",
      "account_number": "1093886",
      "account_type": "checking",
      "bank_ispb": "90400888",
      "bank_number": "033",
      "branch": "4306",
      "id": "018de071-ac62-696f-162b-7b8c289987fe",
      "inserted_at": "2024-02-25T13:26:02.595005Z",
      "updated_at": "2024-02-25T13:26:02.595005Z"
    },
    "counterparty_bank_account_id": "018de071-ac62-696f-162b-7b8c289987fe",
    "counterparty_id": "018dd232-3e22-2f81-768b-27b060cd37c7",
    "description": null,
    "end_to_end_id": "E1320335420240226105493418DB0736",
    "entity_id": "0189b5b4-ea58-a3a8-7c40-f0de1d0cb0af",
    "error_code": null,
    "error_message": null,
    "external_id": "cefbf306-78f4-4b5f-92d9-9a9a2fe6a509",
    "id": "018de50d-47ac-e104-bf9f-8526ff7b524b",
    "origin_id": "018c4685-200e-f7ac-761f-ebb6449bb5e5",
    "origin_type": "api_client",
    "payment_date": "2024-02-26T10:54:29.293000Z",
    "pix_key": "80531369587",
    "receipt_url": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2023-02-26/5ysxfytq.pdf",
    "reconciliation_id": "018de50d-47ac-219a-56dc-9d70efa09634",
    "ref_id": "018de071-ac62-696f-162b-7b8c289987fe",
    "ref_type": "bank_account",
    "status": "refunded",
    "transaction_date": "2024-02-26T10:54:29.292416Z",
    "type": "pix",
    "virtual_account_id": "0189b787-efc8-b0f5-8171-781814fac2a6",
    "without_fee_and_tax": false
  },
  "ref_id": "018de50d-47ac-e104-bf9f-8526ff7b524b",
  "timestamp": "2024-02-26T11:10:37.593188Z",
  "type": "refunded"
}