HomeBlogLoginSignup

Collecting

List all collecting documents

get

List all collecting documents

Query parameters
virtual_account_idstring · uuidRequired

Unique identifier

from_datetimestring · date-timeRequired

Datatime schema

to_datetimestring · date-timeRequired

Datatime schema

reconciliation_idstring · uuidOptional

Unique identifier

ref_typestringOptional

Collecting document ref type

statusstringOptional

Collecting document status

typestringOptional

Collecting document type

beforestringOptional

Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
afterstringOptional

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
Responses
200
Documents
application/json
get
GET /banking/cashin/documents HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "amount": {
        "amount": 100,
        "currency": "BRL"
      },
      "counterparty_bank_account_id": "018f9cb0-8d11-53ba-0550-54933e15377b",
      "counterparty_id": "018f9cb0-8d11-7c91-c62b-d94aec76c1bc",
      "description": "description",
      "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
      "external_id": "external_id",
      "id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
      "initiation": null,
      "origin_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
      "origin_type": "none",
      "receipt_url": "https://receipts.trio.com.br/document_receipts/018f9cb0-8d11-72dd-bb14-f82554e80999",
      "reconciliation_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
      "ref_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
      "ref_type": "pix_qrcode",
      "refunds": [
        {
          "amount": {
            "amount": 10,
            "currency": "BRL"
          },
          "description": "Refund description",
          "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
          "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
          "receipt_url": "https://receipts.trio.com.br/document_receipts/018f9cb0-8d11-72dd-bb14-f82554e80999/refund/018f9cb0-8d37-031e-8b99-bac2919a5033",
          "reconciliation_id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
          "status": "settled",
          "timestamp": "2024-05-21T19:46:07.285344Z",
          "transaction_date": "2024-05-21T19:46:07.285344Z"
        }
      ],
      "stages": [
        {
          "error_code": null,
          "error_message": null,
          "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
          "inserted_at": "2024-05-21T19:46:07.285344Z",
          "status": "settled"
        }
      ],
      "status": "created",
      "timestamp": "2024-05-21T19:46:07.249436Z",
      "transaction_date": "2024-05-21T19:46:07.249436Z",
      "txid": "01HYEB138H6W398TXB3501DF2M",
      "type": "pix",
      "virtual_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999"
    }
  ]
}

Get a collecting document

get

Get a collecting document

Path parameters
idstring · uuidRequired

Unique identifier

Responses
200
Document
application/json
get
GET /banking/cashin/documents/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "amount": {
      "amount": 100,
      "currency": "BRL"
    },
    "counterparty_bank_account_id": "018f9cb0-8d11-53ba-0550-54933e15377b",
    "counterparty_id": "018f9cb0-8d11-7c91-c62b-d94aec76c1bc",
    "description": "description",
    "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
    "external_id": "external_id",
    "id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
    "initiation": null,
    "origin_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
    "origin_type": "none",
    "receipt_url": "https://receipts.trio.com.br/document_receipts/018f9cb0-8d11-72dd-bb14-f82554e80999",
    "reconciliation_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
    "ref_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
    "ref_type": "pix_qrcode",
    "refunds": [
      {
        "amount": {
          "amount": 10,
          "currency": "BRL"
        },
        "description": "Refund description",
        "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
        "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
        "receipt_url": "https://receipts.trio.com.br/document_receipts/018f9cb0-8d11-72dd-bb14-f82554e80999/refund/018f9cb0-8d37-031e-8b99-bac2919a5033",
        "reconciliation_id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
        "status": "settled",
        "timestamp": "2024-05-21T19:46:07.285344Z",
        "transaction_date": "2024-05-21T19:46:07.285344Z"
      }
    ],
    "stages": [
      {
        "error_code": null,
        "error_message": null,
        "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
        "inserted_at": "2024-05-21T19:46:07.285344Z",
        "status": "settled"
      }
    ],
    "status": "created",
    "timestamp": "2024-05-21T19:46:07.249436Z",
    "transaction_date": "2024-05-21T19:46:07.249436Z",
    "txid": "01HYEB138H6W398TXB3501DF2M",
    "type": "pix",
    "virtual_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999"
  }
}

Search collecting document

get

Search collecting document

Query parameters
end_to_end_idstringOptional

End To End ID

external_idstringOptional

External ID

from_datetimestring · date-timeOptional

Datatime schema

to_datetimestring · date-timeOptional

Datatime schema

Responses
200
Document
application/json
get
GET /banking/cashin/documents/search HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "amount": {
      "amount": 100,
      "currency": "BRL"
    },
    "counterparty_bank_account_id": "018f9cb0-8d11-53ba-0550-54933e15377b",
    "counterparty_id": "018f9cb0-8d11-7c91-c62b-d94aec76c1bc",
    "description": "description",
    "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
    "external_id": "external_id",
    "id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
    "initiation": null,
    "origin_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
    "origin_type": "none",
    "receipt_url": "https://receipts.trio.com.br/document_receipts/018f9cb0-8d11-72dd-bb14-f82554e80999",
    "reconciliation_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
    "ref_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
    "ref_type": "pix_qrcode",
    "refunds": [
      {
        "amount": {
          "amount": 10,
          "currency": "BRL"
        },
        "description": "Refund description",
        "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
        "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
        "receipt_url": "https://receipts.trio.com.br/document_receipts/018f9cb0-8d11-72dd-bb14-f82554e80999/refund/018f9cb0-8d37-031e-8b99-bac2919a5033",
        "reconciliation_id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
        "status": "settled",
        "timestamp": "2024-05-21T19:46:07.285344Z",
        "transaction_date": "2024-05-21T19:46:07.285344Z"
      }
    ],
    "stages": [
      {
        "error_code": null,
        "error_message": null,
        "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
        "inserted_at": "2024-05-21T19:46:07.285344Z",
        "status": "settled"
      }
    ],
    "status": "created",
    "timestamp": "2024-05-21T19:46:07.249436Z",
    "transaction_date": "2024-05-21T19:46:07.249436Z",
    "txid": "01HYEB138H6W398TXB3501DF2M",
    "type": "pix",
    "virtual_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999"
  }
}

PreviousDocumentsNextCollecting - Refund

Last updated

Was this helpful?