HomeBlogLoginSignup

Recurrences

List recurrences

get

List recurrences with parameters

Query parameters
entity_idstring · uuidOptional

Recurrence Entity Id

virtual_account_idstring · uuidOptional

Virtual Account Id

from_datetimestring · date-timeRequired

Recurrence datetime, lower bound for the list of recurrences

to_datetimestring · date-timeRequired

Recurrence datetime, upper bound for the list of recurrences

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==
limitintegerOptional

Number of registries to be returned

Responses
200
Recurrences
application/json
get
GET /banking/cashin/pix/recurrences HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "counterparty_bank_account_id": "019838eb-aa45-1645-c9f7-a3353e61f44d",
      "start_date": "2025-07-14T16:52:19.991825Z",
      "group_id": "019838eb-aa45-f8db-c79e-d735dbcf61b7",
      "counterparty_id": "019838eb-aa45-7090-cd0e-ea2d59f159d6",
      "automated_collecting": false,
      "inserted_at": "2025-07-14T16:52:19.991825Z",
      "type": "in",
      "entity_id": "019838eb-aa45-ea38-9044-2371b54d390b",
      "reference_id": "019838eb-aa45-4308-43ba-1031945b079d",
      "approval_type": "qrdn",
      "minimum_amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "ispb": "19947272",
      "first_payment_date": "2025-07-14T16:52:19.991825Z",
      "virtual_account_id": "019838eb-aa45-15be-8b47-aa3258e82bd9",
      "number_of_collections": 10,
      "company_id": "019838eb-aa45-d5b9-f265-ffba0850afc4",
      "end_date": "2025-07-14T16:52:19.991825Z",
      "status": "approved",
      "updated_at": "2025-07-14T16:52:19.991825Z",
      "next_working_day": true,
      "description": "Descrição da recorrência",
      "id": "019838eb-aa3d-92eb-37dc-6ae77f63cf93",
      "id_rec": "019838eb-aa45-5733-322b-c829c1089f83",
      "fixed_amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "contract_number": "123",
      "txid": "HASHJDFHJASDJHFUU23E1287317823",
      "journey": "aut1",
      "external_id": "Teste 1",
      "authorization_date": "2025-07-14T16:52:19.991825Z",
      "retry_policy": "none",
      "timestamp": "2025-07-14T16:52:19.991825Z",
      "origin_id": "019838eb-aa45-2aab-9622-80d0e0e9dd76",
      "org_id": "019838eb-aa45-9672-12e5-c6fadec56545",
      "first_payment_amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "maximum_amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "periodicity": "week",
      "origin_type": "api_client",
      "update_date": "2025-07-14T16:52:19.991825Z",
      "counterparty_info_id": "019838eb-aa45-a02a-a9a7-7b6ca7822a4d",
      "counterparty_seq": "12"
    }
  ]
}

Generate a recurrence

post

Generate a recurrence

Body
one ofOptional

Generate a Recurrence

or
or
Responses
202
GenerateRecurrenceResponse
application/json
post
POST /banking/cashin/pix/recurrences HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 577

{
  "amount": {
    "fixed": 1,
    "maximum": 1
  },
  "approval_type": "requ",
  "automated_collecting": true,
  "contract_number": "text",
  "counterparty": {
    "bank_account": {
      "branch": "text",
      "digit": "text",
      "ispb": "text",
      "number": "text"
    },
    "info": {
      "address": "text",
      "city": "text",
      "email": "text",
      "postal_code": "text",
      "state": "text"
    },
    "name": "text",
    "tax_number": "text"
  },
  "description": "text",
  "end_date": "2025-07-31T00:03:21.465Z",
  "external_id": "text",
  "next_working_day": true,
  "periodicity": "week",
  "retry_policy": "none",
  "start_date": "2025-07-31T00:03:21.465Z",
  "virtual_account_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "data": {
    "dynamic_qrcode": {
      "hash": "0000BResdasadjvajsidunajkTTrioTecnologia",
      "id": "019838eb-ac82-8813-044b-d40f1699da8e"
    },
    "recurrence_id": "019838eb-ac82-f418-f30f-67fbb0d735a2",
    "static_qrcode": null
  }
}

Get recurrence

get

Get recurrence with stages

Path parameters
idstring · uuidRequired

Recurrence Id

Query parameters
entity_idstring · uuidOptional

Entity Id

group_idstring · uuidOptional

Group Id

virtual_account_idstring · uuidOptional

Virtual account Id

load_stagesbooleanOptional

Load stages?

load_requestsbooleanOptional

Load requests?

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

{
  "data": {
    "counterparty_bank_account_id": "01983339-9297-c83c-b555-10d5faadea29",
    "start_date": "2025-07-14T16:52:19.991825Z",
    "request_id": "019838eb-ab72-26cd-897b-a9ae6caa4a3a",
    "group_id": "019838eb-aa45-f8db-c79e-d735dbcf61b7",
    "counterparty_id": "01983339-9297-84e8-0cea-8bf4f32bfc78",
    "automated_collecting": false,
    "inserted_at": "2025-07-14T16:52:19.991825Z",
    "type": "in",
    "entity_id": "019838eb-aa45-ea38-9044-2371b54d390b",
    "reference_id": "019838eb-ab72-f2bb-c0c0-2b66c1983ff9",
    "id_solic_rec": "1234567890",
    "recurrence_id": "01983339-9297-da8f-1f35-1fa1ff9a6686",
    "approval_type": "qrdn",
    "minimum_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "ispb": "19947272",
    "first_payment_date": "2025-07-14T16:52:19.991825Z",
    "rejection_code": "rejection_code_example",
    "virtual_account_id": "019838eb-ab72-48d8-6859-0826ec91a235",
    "number_of_collections": 10,
    "company_id": "019838eb-aa45-d5b9-f265-ffba0850afc4",
    "rejection_description": "Rejection description example",
    "expiration_date": "2025-07-14T16:52:19.991825Z",
    "end_date": "2025-07-14T16:52:19.991825Z",
    "status": "created",
    "updated_at": "2025-07-14T16:52:19.991825Z",
    "next_working_day": true,
    "description": "Descrição da recorrência",
    "id": "01983339-9297-376d-600f-e9baacce9e65",
    "cancelation_description": "Cancelation description example",
    "id_rec": "019838eb-aa45-5733-322b-c829c1089f83",
    "collection_id": "019838eb-ab72-f56e-5dec-987fe2233e74",
    "fixed_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "contract_number": "123",
    "recurrence_timestamp": "2025-07-14T16:52:19.991825Z",
    "txid": "HASHJDFHJASDJHFUU23E1287317823",
    "error_code": "error_code_example",
    "error_message": "Error message example",
    "journey": "aut1",
    "external_id": "Teste 1",
    "authorization_date": "2025-07-14T16:52:19.991825Z",
    "request_timestamp": "2025-07-14T16:52:19.991825Z",
    "retry_policy": "none",
    "timestamp": "2025-07-14T16:52:19.991825Z",
    "origin_id": "019838eb-aa45-2aab-9622-80d0e0e9dd76",
    "org_id": "019838eb-aa45-9672-12e5-c6fadec56545",
    "first_payment_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "maximum_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "reference_type": "qrdn",
    "periodicity": "week",
    "cancelation_origin": "cancelation_origin_example",
    "collection_timestamp": "2025-07-14T16:52:19.991825Z",
    "origin_type": "api_client",
    "update_date": "2025-07-14T16:52:19.991825Z",
    "cancelation_code": "cancelation_code_example",
    "counterparty_info_id": "019838eb-aa45-a02a-a9a7-7b6ca7822a4d",
    "counterparty_seq": 1
  }
}

Cancel recurrence

post

Cancel recurrence by ID

Path parameters
idstringRequired

Recurrence ID

Body

CancelRecurrenceParams with ID

cancellation_reasonstringRequired

Cancellation reason

requester_tax_numberstringRequired

Requester Tax Number

Responses
202
Recurrence
application/json
post
POST /banking/cashin/pix/recurrences/{id}/cancel HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "cancellation_reason": "Cancelled due to ...",
  "requester_tax_number": "80617053000195"
}
{
  "data": {
    "counterparty_bank_account_id": "01983339-9297-c83c-b555-10d5faadea29",
    "start_date": "2025-07-14T16:52:19.991825Z",
    "request_id": "019838eb-ab72-26cd-897b-a9ae6caa4a3a",
    "group_id": "019838eb-aa45-f8db-c79e-d735dbcf61b7",
    "counterparty_id": "01983339-9297-84e8-0cea-8bf4f32bfc78",
    "automated_collecting": false,
    "inserted_at": "2025-07-14T16:52:19.991825Z",
    "type": "in",
    "entity_id": "019838eb-aa45-ea38-9044-2371b54d390b",
    "reference_id": "019838eb-ab72-f2bb-c0c0-2b66c1983ff9",
    "id_solic_rec": "1234567890",
    "recurrence_id": "01983339-9297-da8f-1f35-1fa1ff9a6686",
    "approval_type": "qrdn",
    "minimum_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "ispb": "19947272",
    "first_payment_date": "2025-07-14T16:52:19.991825Z",
    "rejection_code": "rejection_code_example",
    "virtual_account_id": "019838eb-ab72-48d8-6859-0826ec91a235",
    "number_of_collections": 10,
    "company_id": "019838eb-aa45-d5b9-f265-ffba0850afc4",
    "rejection_description": "Rejection description example",
    "expiration_date": "2025-07-14T16:52:19.991825Z",
    "end_date": "2025-07-14T16:52:19.991825Z",
    "status": "created",
    "updated_at": "2025-07-14T16:52:19.991825Z",
    "next_working_day": true,
    "description": "Descrição da recorrência",
    "id": "01983339-9297-376d-600f-e9baacce9e65",
    "cancelation_description": "Cancelation description example",
    "id_rec": "019838eb-aa45-5733-322b-c829c1089f83",
    "collection_id": "019838eb-ab72-f56e-5dec-987fe2233e74",
    "fixed_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "contract_number": "123",
    "recurrence_timestamp": "2025-07-14T16:52:19.991825Z",
    "txid": "HASHJDFHJASDJHFUU23E1287317823",
    "error_code": "error_code_example",
    "error_message": "Error message example",
    "journey": "aut1",
    "external_id": "Teste 1",
    "authorization_date": "2025-07-14T16:52:19.991825Z",
    "request_timestamp": "2025-07-14T16:52:19.991825Z",
    "retry_policy": "none",
    "timestamp": "2025-07-14T16:52:19.991825Z",
    "origin_id": "019838eb-aa45-2aab-9622-80d0e0e9dd76",
    "org_id": "019838eb-aa45-9672-12e5-c6fadec56545",
    "first_payment_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "maximum_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "reference_type": "qrdn",
    "periodicity": "week",
    "cancelation_origin": "cancelation_origin_example",
    "collection_timestamp": "2025-07-14T16:52:19.991825Z",
    "origin_type": "api_client",
    "update_date": "2025-07-14T16:52:19.991825Z",
    "cancelation_code": "cancelation_code_example",
    "counterparty_info_id": "019838eb-aa45-a02a-a9a7-7b6ca7822a4d",
    "counterparty_seq": 1
  }
}

List recurrence collections

get

List recurrence collections with parameters

Query parameters
entity_idstring · uuidOptional

Unique identifier

recurrence_idstring · uuidRequired

Unique identifier

from_datetimestring · date-timeRequired

Datetime schema

to_datetimestring · date-timeRequired

Datetime schema

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==
limitintegerOptional

Number of registries to be returned

Responses
200
Collections
application/json
get
GET /banking/cashin/pix/recurrences/collections HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "aditional_info": "ADITIONAL INFO",
      "amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "company_id": "01983339-93fc-1410-7049-684814a56c2c",
      "counterparty_info_id": "01983339-93fc-0266-d10a-79608f25e6bd",
      "entity_id": "01983339-93fc-35b2-0b16-bb79b8009449",
      "final_date": "2025-07-14T16:52:19.991825Z",
      "group_id": "01983339-93fc-9609-ef47-575fd7eb6cc4",
      "id": "01983339-93fc-bb46-2599-03e29982bbb3",
      "inserted_at": "2025-07-14T16:52:19.991825Z",
      "next_working_day": "2025-07-14T16:52:19.991825Z",
      "org_id": "01983339-93fc-8991-1b1e-5ebee0e36bf2",
      "recurrence_id": "01983339-93fc-0119-cee4-6aebd34a8537",
      "recurrence_timestamp": "2025-07-14T16:52:19.991825Z",
      "status": "created",
      "timestamp": "2025-07-14T16:52:19.991825Z",
      "transaction_date": "2025-07-14T16:52:19.991825Z",
      "txid": "1276T31G7T623GTYU123GJTY123JGTY",
      "updated_at": "2025-07-14T16:52:19.991825Z",
      "virtual_account_id": "01983339-93fc-31bf-e6e8-a7ce7ed65534"
    }
  ]
}

Get recurrence collection

get

Get recurrence collection

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
timestampstring · date-timeOptional

Datetime schema

entity_idstring · uuidOptional

Unique identifier

group_idstring · uuidOptional

Unique identifier

virtual_account_idstring · uuidOptional

Unique identifier

load_stagesbooleanOptional

Load stages?

load_attemptsbooleanOptional

Load attempts?

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

{
  "data": {
    "aditional_info": "ADITIONAL INFO",
    "amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "company_id": "01983339-9390-61d4-38fa-6af71a400d04",
    "counterparty_info_id": "01983339-9390-e8e6-edb0-90657c8dff08",
    "entity_id": "01983339-9390-58f9-2f4b-156b72aed97d",
    "final_date": "2025-07-14T16:52:19.991825Z",
    "group_id": "01983339-9390-dbb5-515c-92c00bb88d7a",
    "id": "01983339-9390-f015-d2df-cba8f9f52e89",
    "inserted_at": "2025-07-14T16:52:19.991825Z",
    "next_working_day": "2025-07-14T16:52:19.991825Z",
    "org_id": "01983339-9390-e64b-cb85-351a425d4fea",
    "recurrence_id": "01983339-9390-8ac4-cd4a-8ee6d8cc6b9e",
    "recurrence_timestamp": "2025-07-14T16:52:19.991825Z",
    "status": "created",
    "timestamp": "2025-07-14T16:52:19.991825Z",
    "transaction_date": "2025-07-14T16:52:19.991825Z",
    "txid": "1276T31G7T623GTYU123GJTY123JGTY",
    "updated_at": "2025-07-14T16:52:19.991825Z",
    "virtual_account_id": "01983339-9390-a48d-570e-5f41da4c9bd1"
  }
}

Update collection Amount

put

Update collection Amount by ID

Path parameters
idstringRequired

Collection ID

Body

CollectionUpdateParams

amountintegerRequired

Updated amount

Responses
200
Collection
application/json
Responsestring · stringExample: No Content
put
PUT /banking/cashin/pix/recurrences/collections/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "amount": 10000
}
No Content

Schedule collection

post

Schedule collection

Path parameters
idstring · uuidRequired

Unique identifier

Body

Schedule update params

collection_timestampstring · date-timeRequired

collection timestamp

Responses
204
No Content
application/json
Responsestring · stringExample: No Content
post
POST /banking/cashin/pix/recurrences/collections/{id}/schedule HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "collection_timestamp": "2025-07-22T17:41:08.439367Z"
}
No Content

Cancel collection

post

Cancel collection by ID

Path parameters
idstringRequired

Collection ID

Body

CancelCollectionParams with ID

cancellation_reasonstringRequired

Cancellation reason

requester_tax_numberstringRequired

Requester Tax Number

Responses
202
Collection
application/json
post
POST /banking/cashin/pix/recurrences/collections/{id}/cancel HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "cancellation_reason": "Cancelled due to...",
  "requester_tax_number": "14633666800"
}
{
  "data": {
    "aditional_info": "ADITIONAL INFO",
    "amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "company_id": "01983339-9390-61d4-38fa-6af71a400d04",
    "counterparty_info_id": "01983339-9390-e8e6-edb0-90657c8dff08",
    "entity_id": "01983339-9390-58f9-2f4b-156b72aed97d",
    "final_date": "2025-07-14T16:52:19.991825Z",
    "group_id": "01983339-9390-dbb5-515c-92c00bb88d7a",
    "id": "01983339-9390-f015-d2df-cba8f9f52e89",
    "inserted_at": "2025-07-14T16:52:19.991825Z",
    "next_working_day": "2025-07-14T16:52:19.991825Z",
    "org_id": "01983339-9390-e64b-cb85-351a425d4fea",
    "recurrence_id": "01983339-9390-8ac4-cd4a-8ee6d8cc6b9e",
    "recurrence_timestamp": "2025-07-14T16:52:19.991825Z",
    "status": "created",
    "timestamp": "2025-07-14T16:52:19.991825Z",
    "transaction_date": "2025-07-14T16:52:19.991825Z",
    "txid": "1276T31G7T623GTYU123GJTY123JGTY",
    "updated_at": "2025-07-14T16:52:19.991825Z",
    "virtual_account_id": "01983339-9390-a48d-570e-5f41da4c9bd1"
  }
}

Get recurrence collection attempt

get

Get recurrence collection attempt

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
timestampstring · date-timeOptional

Datetime schema

entity_idstring · uuidOptional

Unique identifier

load_stagesbooleanOptional

Load stages?

Responses
200
Collection
application/json
get
GET /banking/cashin/pix/recurrences/collections/attempts/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "collection_id": "01983339-92e7-b820-b292-b3355158ce97",
    "collection_timestamp": "2025-07-14T16:52:19.991825Z",
    "due_date": "2025-07-14T16:52:19.991825Z",
    "end_to_end_id": "E123123124120510240124BJJHBVGHBJGHBJHKNJ",
    "external_id": "external id 1",
    "id": "01983339-92e7-5eed-bc31-7944a64d8bdf",
    "inserted_at": "2025-07-14T16:52:19.991825Z",
    "status": "created",
    "timestamp": "2025-07-14T16:52:19.991825Z",
    "transaction_date": "2025-07-14T16:52:19.991825Z",
    "txid": "1276T31G7T623GTYU123GJTY123JGTY",
    "type": "type",
    "updated_at": "2025-07-14T16:52:19.991825Z"
  }
}

Get recurrence request

get

Get recurrence request

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
entity_idstring · uuidOptional

Unique identifier

group_idstring · uuidOptional

Unique identifier

virtual_account_idstring · uuidOptional

Unique identifier

load_stagesbooleanOptional

Load stages?

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

{
  "data": {
    "counterparty_bank_account_id": "01983339-9297-c83c-b555-10d5faadea29",
    "counterparty_id": "01983339-9297-84e8-0cea-8bf4f32bfc78",
    "counterparty_seq": 1,
    "expiration_date": "2025-07-14T16:52:19.991825Z",
    "id": "01983339-9297-376d-600f-e9baacce9e65",
    "id_solic_rec": "1234567890",
    "inserted_at": "2025-07-14T16:52:19.991825Z",
    "recurrence_id": "01983339-9297-da8f-1f35-1fa1ff9a6686",
    "recurrence_timestamp": "2025-07-14T16:52:19.991825Z",
    "status": "created",
    "timestamp": "2025-07-14T16:52:19.991825Z",
    "updated_at": "2025-07-14T16:52:19.991825Z"
  }
}
PreviousWebhooksNextInvoice installments

Was this helpful?