LogoLogo
HomeBlogLoginSignup
  • Get started
  • Guides
  • Reference
  • Banking API
    • Entities
    • Counterparties
    • Institutions
    • Bank accounts
    • Virtual accounts
    • Collecting
      • Dynamic QR codes
      • Static QR codes
      • Refund
    • Payment
      • Pix Key
      • Pix Brcode
    • Transfer
    • Documents
      • Collecting
      • Collecting - Refund
      • Payment
      • Payment - Refund
      • Transfer
    • Checkout
    • Developers
      • Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. Banking API
  2. Documents

Transfer

PreviousPayment - RefundNextCheckout

Last updated 4 months ago

Was this helpful?

List transfer documents

get

List transfer documents

Query parameters
from_virtual_account_idstring · uuidOptional

Unique identifier

to_virtual_account_idstring · uuidOptional

Unique identifier

from_datetimestring · date-timeRequired

Datatime schema

to_datetimestring · date-timeRequired

Datatime schema

external_idstringOptional

External ID

reconciliation_idstring · uuidOptional

Unique identifier

statusstringOptional

Status of the transfer document

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
401
Unauthorized
application/json
500
Internal server error
application/json
get
GET /banking/cashout/transfer HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
  "data": [
    {
      "amount": {
        "amount": 100,
        "currency": "BRL"
      },
      "bank_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
      "description": "description",
      "external_id": "external_id",
      "from_virtual_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
      "id": "018f9cb0-8d11-f5da-31a1-0c243407d6d3",
      "origin_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
      "origin_type": "none",
      "reconciliation_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
      "stages": [
        {
          "error_code": null,
          "error_message": null,
          "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
          "timestamp": "2024-05-21T19:46:07.285344Z",
          "type": "created"
        }
      ],
      "status": "created",
      "timestamp": "2024-05-21T19:46:07.249436Z",
      "to_virtual_account_id": "018f9cb0-8d11-53ba-0550-54933e15377b",
      "transaction_date": "2024-05-21T19:46:07.249436Z"
    }
  ]
}

Get a transfer document

get

Gets a transfer document

Path parameters
idstring · uuidRequired

Unique identifier

Responses
200
Document
application/json
401
Unauthorized
application/json
500
Internal server error
application/json
get
GET /banking/cashout/transfer/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
  "data": {
    "amount": {
      "amount": 100,
      "currency": "BRL"
    },
    "bank_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
    "description": "description",
    "external_id": "external_id",
    "from_virtual_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
    "id": "018f9cb0-8d11-f5da-31a1-0c243407d6d3",
    "origin_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
    "origin_type": "none",
    "reconciliation_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
    "stages": [
      {
        "error_code": null,
        "error_message": null,
        "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
        "timestamp": "2024-05-21T19:46:07.285344Z",
        "type": "created"
      }
    ],
    "status": "created",
    "timestamp": "2024-05-21T19:46:07.249436Z",
    "to_virtual_account_id": "018f9cb0-8d11-53ba-0550-54933e15377b",
    "transaction_date": "2024-05-21T19:46:07.249436Z"
  }
}
  • GETList transfer documents
  • GETGet a transfer document