Recurrences
List recurrences with parameters
Recurrence Entity Id
Virtual Account Id
Recurrence datetime, lower bound for the list of recurrences
Recurrence datetime, upper bound for the list of recurrences
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.
g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
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.
g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
Number of registries to be returned
Recurrences
Unprocessable Entity
Unprocessable Entity
GET /banking/cashin/pix/recurrences HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
"data": [
{
"counterparty_bank_account_id": "01993eeb-91c1-84fd-e379-d0f19197429a",
"start_date": "2025-09-12T17:14:09.729614Z",
"counterparty_id": "01993eeb-91c1-0a3a-b551-9c0cac215310",
"inserted_at": "2025-09-12T17:14:09.729622Z",
"type": "in",
"entity_id": "01993eeb-91c1-d5f3-aa77-f01662f1ed19",
"reference_id": "01993eeb-91c1-2eff-6b1d-822b966eca96",
"approval_type": "qrdn",
"minimum_amount": {
"amount": 10,
"currency": "BRL"
},
"ispb": "19947272",
"first_payment_date": "2025-09-12T17:14:09.729612Z",
"virtual_account_id": "01993eeb-91c1-0a35-4e98-a9c66ad7788c",
"number_of_collections": 10,
"company_id": "01993eeb-91c1-b047-0ecf-920da858f939",
"automatic_schedule": false,
"end_date": "2025-09-12T17:14:09.729615Z",
"status": "approved",
"updated_at": "2025-09-12T17:14:09.729623Z",
"next_working_day": true,
"description": "Descrição da recorrência",
"id": "01993eeb-91c1-31bf-4733-fafce541d685",
"id_rec": "01993eeb-91c1-a3c1-f123-dcbc348d99fd",
"fixed_amount": {
"amount": 10,
"currency": "BRL"
},
"contract_number": "123",
"txid": "HASHJDFHJASDJHFUU23E1287317823",
"journey": "aut1",
"external_id": "Teste 1",
"authorization_date": "2025-09-12T17:14:09.729618Z",
"retry_policy": "none",
"timestamp": "2025-09-12T17:14:09.729570Z",
"origin_id": "01993eeb-91c1-a0b5-044a-9e7186877d7a",
"org_id": "01993eeb-91c1-a39d-6ed2-9b39947f33e7",
"first_payment_amount": {
"amount": 10,
"currency": "BRL"
},
"maximum_amount": {
"amount": 10,
"currency": "BRL"
},
"periodicity": "week",
"origin_type": "api_client",
"update_date": "2025-09-12T17:14:09.729617Z",
"bank_account_id": "01993eeb-91c1-c963-b73a-518bbba56179",
"counterparty_info_id": "01993eeb-91c1-c86b-7130-02a851d4f4bf",
"counterparty_seq": "12"
}
]
}
Generate a recurrence
GenerateRecurrenceParameters
Contract Number
Description
Recurrence End Date
Recurrence External ID
'week': every week, 'mnth': every month, 'qurt': every 3 months, 'mian': every 6 months, 'year': every year
Recurrence Start Date
Virtual Account ID
Generate Recurrence Response
Unprocessable Entity
Unprocessable Entity
POST /banking/cashin/pix/recurrences HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 1021
{
"amounts": {
"minimum": 100
},
"contract_number": "123456789",
"counterparty": {
"bank_account": {
"branch": "1234",
"digit": "1",
"ispb": "12345678",
"number": "123456"
},
"name": "John Doe",
"tax_number": "80617053000195"
},
"description": "Monthly payment for services",
"external_id": "external_id_123",
"first_payment": {
"amount": 1000,
"dict_key": "[email protected]",
"due_detail": {
"discount": 2,
"discount_amounts": [],
"discount_antecipation_type": "per_day_antecipated",
"discount_calculation_days": "working",
"discount_calculation_type": "amount",
"discount_dates": [],
"due_date": "2025-09-12",
"fine": 10,
"fine_calculation_type": "percentage",
"interest": 20,
"interest_calculation_days": "calendar",
"interest_calculation_period": "month",
"interest_calculation_type": "amount",
"rebate": 50,
"rebate_calculation_type": "percentage"
}
},
"options": {
"authorization_type": "app",
"automatic_schedule": false,
"next_working_day": true,
"retry_policy": "3r_7d"
},
"periodicity": "mnth",
"start_date": "2025-09-12T17:14:09.896587Z",
"virtual_account_id": "01993eeb-9268-9ad9-cd57-9cdab269324b"
}
{
"data": {
"counterparty_bank_account_id": "01993eeb-922e-69d0-3cd8-b8cf11e48102",
"start_date": "2025-09-12T17:14:09.838619Z",
"counterparty_id": "01993eeb-922e-01bd-2466-107308142507",
"type": "in",
"entity_id": "01993eeb-922e-3aef-f686-c65a8c9e9d4a",
"reference_id": "01993eeb-922e-723d-4699-1263bbbb5d8b",
"minimum_amount": {
"amount": 10,
"currency": "BRL"
},
"ispb": "19947272",
"first_payment_date": "2025-09-12T17:14:09.838618Z",
"virtual_account_id": "01993eeb-922e-1018-037b-3dee06df1835",
"company_id": "01993eeb-922e-3831-40a1-9ea38f69afe8",
"automatic_schedule": false,
"end_date": "2025-09-12T17:14:09.838621Z",
"status": "approved",
"next_working_day": true,
"description": "Descrição da recorrência",
"id": "01993eeb-922e-0ebe-b296-fefd8038da94",
"id_rec": "01993eeb-922e-d8e1-028a-bb38d8ab2e1e",
"fixed_amount": {
"amount": 10,
"currency": "BRL"
},
"contract_number": "123",
"txid": "HASHEDER3E1287317823",
"journey": "aut1",
"external_id": "Teste 1",
"retry_policy": "none",
"timestamp": "2025-09-12T17:14:09.838603Z",
"org_id": "01993eeb-922e-689d-2856-2c25dda02e54",
"first_payment_amount": {
"amount": 10,
"currency": "BRL"
},
"maximum_amount": {
"amount": 10,
"currency": "BRL"
},
"reference_type": "qrdn",
"periodicity": "week",
"qrcode": {
"hash": "0000BResdasadjvajsidunajkTTrioTecnologia",
"id": "01993eeb-922e-84c4-d773-90892a1f527c",
"type": "dynamic"
},
"bank_account_id": "01993eeb-922e-0792-835a-48769ec81bd8",
"counterparty_info_id": "01993eeb-922e-644a-7dd0-374a337e3e02",
"counterparty_seq": "12"
}
}
List recurrence collections with parameters
Unique identifier
Unique identifier
Datetime schema
Datetime schema
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.
g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
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.
g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
Number of registries to be returned
Collections
Unprocessable Entity
Unprocessable Entity
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"
},
"bank_account_id": "01991a52-40c9-ef5d-62a4-9b7b8983a6f7",
"company_id": "01991a52-40c9-a202-3901-1c5edc193541",
"counterparty_info_id": "01991a52-40c9-e96f-bf1d-e9006437946e",
"entity_id": "01991a52-40c9-6dec-ced6-92fe6c7642f9",
"final_date": "2025-09-05T14:40:22.217863Z",
"id": "01991a52-40c9-1caa-1706-5087be66c3a9",
"inserted_at": "2025-09-05T14:40:22.217874Z",
"next_working_day": "2025-09-05T14:40:22.217864Z",
"org_id": "01991a52-40c9-53fe-23b3-49a2adb289ff",
"recurrence_id": "01991a52-40c9-386c-0c5f-c52e5b8078de",
"recurrence_timestamp": "2025-09-05T14:40:22.217860Z",
"status": "created",
"timestamp": "2025-09-05T14:40:22.217845Z",
"transaction_date": "2025-09-05T14:40:22.217862Z",
"txid": "1276T31G7T623GTYU123GJTY123JGTY",
"updated_at": "2025-09-05T14:40:22.217876Z",
"virtual_account_id": "01991a52-40c9-7991-1916-6dabb24a7f99"
}
]
}
Get recurrence collection attempt
Unique identifier
Unique identifier
Load stages?
Collection
Unprocessable Entity
Unprocessable Entity
GET /banking/cashin/pix/recurrences/collections/attempts/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
"data": {
"collection_id": "01991a52-40ce-b3fd-55b6-8810e616b0b9",
"collection_timestamp": "2025-09-05T14:40:22.222089Z",
"due_date": "2025-09-05T14:40:22.222093Z",
"end_to_end_id": "E123123124120510240124BJJHBVGHBJGHBJHKNJ",
"external_id": "external id 1",
"id": "01991a52-40ce-4d8c-6882-a738ed3716b5",
"inserted_at": "2025-09-05T14:40:22.222095Z",
"status": "created",
"timestamp": "2025-09-05T14:40:22.222073Z",
"transaction_date": "2025-09-05T14:40:22.222091Z",
"txid": "1276T31G7T623GTYU123GJTY123JGTY",
"type": "type",
"updated_at": "2025-09-05T14:40:22.222097Z"
}
}
Create next collection
Create NextCollection params
Recurrence ID
Collection
Unprocessable Entity
Unprocessable Entity
POST /banking/cashin/pix/recurrences/collections/create_next_collection HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"recurrence_id": "01991a52-454f-538c-fada-7abe88012b37"
}
{
"data": {
"aditional_info": "ADITIONAL INFO",
"amount": {
"amount": 10,
"currency": "BRL"
},
"bank_account_id": "01991a52-40c9-ef5d-62a4-9b7b8983a6f7",
"company_id": "01991a52-40c9-a202-3901-1c5edc193541",
"counterparty_info_id": "01991a52-40c9-e96f-bf1d-e9006437946e",
"entity_id": "01991a52-40c9-6dec-ced6-92fe6c7642f9",
"final_date": "2025-09-05T14:40:22.217863Z",
"id": "01991a52-40c9-1caa-1706-5087be66c3a9",
"inserted_at": "2025-09-05T14:40:22.217874Z",
"next_working_day": "2025-09-05T14:40:22.217864Z",
"org_id": "01991a52-40c9-53fe-23b3-49a2adb289ff",
"recurrence_id": "01991a52-40c9-386c-0c5f-c52e5b8078de",
"recurrence_timestamp": "2025-09-05T14:40:22.217860Z",
"status": "created",
"timestamp": "2025-09-05T14:40:22.217845Z",
"transaction_date": "2025-09-05T14:40:22.217862Z",
"txid": "1276T31G7T623GTYU123GJTY123JGTY",
"updated_at": "2025-09-05T14:40:22.217876Z",
"virtual_account_id": "01991a52-40c9-7991-1916-6dabb24a7f99"
}
}
Get recurrence collection
Unique identifier
Unique identifier
Unique identifier
Unique identifier
Load stages?
Load attempts?
Collection
Unprocessable Entity
Unprocessable Entity
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"
},
"bank_account_id": "01991a52-40c9-ef5d-62a4-9b7b8983a6f7",
"company_id": "01991a52-40c9-a202-3901-1c5edc193541",
"counterparty_info_id": "01991a52-40c9-e96f-bf1d-e9006437946e",
"entity_id": "01991a52-40c9-6dec-ced6-92fe6c7642f9",
"final_date": "2025-09-05T14:40:22.217863Z",
"id": "01991a52-40c9-1caa-1706-5087be66c3a9",
"inserted_at": "2025-09-05T14:40:22.217874Z",
"next_working_day": "2025-09-05T14:40:22.217864Z",
"org_id": "01991a52-40c9-53fe-23b3-49a2adb289ff",
"recurrence_id": "01991a52-40c9-386c-0c5f-c52e5b8078de",
"recurrence_timestamp": "2025-09-05T14:40:22.217860Z",
"status": "created",
"timestamp": "2025-09-05T14:40:22.217845Z",
"transaction_date": "2025-09-05T14:40:22.217862Z",
"txid": "1276T31G7T623GTYU123GJTY123JGTY",
"updated_at": "2025-09-05T14:40:22.217876Z",
"virtual_account_id": "01991a52-40c9-7991-1916-6dabb24a7f99"
}
}
Update collection Amount by ID
Collection ID
Collection update params
Updated amount
Collection
Unprocessable Entity
Unprocessable Entity
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
}
{
"data": {
"aditional_info": "ADITIONAL INFO",
"amount": {
"amount": 10,
"currency": "BRL"
},
"bank_account_id": "01991a52-40c9-ef5d-62a4-9b7b8983a6f7",
"company_id": "01991a52-40c9-a202-3901-1c5edc193541",
"counterparty_info_id": "01991a52-40c9-e96f-bf1d-e9006437946e",
"entity_id": "01991a52-40c9-6dec-ced6-92fe6c7642f9",
"final_date": "2025-09-05T14:40:22.217863Z",
"id": "01991a52-40c9-1caa-1706-5087be66c3a9",
"inserted_at": "2025-09-05T14:40:22.217874Z",
"next_working_day": "2025-09-05T14:40:22.217864Z",
"org_id": "01991a52-40c9-53fe-23b3-49a2adb289ff",
"recurrence_id": "01991a52-40c9-386c-0c5f-c52e5b8078de",
"recurrence_timestamp": "2025-09-05T14:40:22.217860Z",
"status": "created",
"timestamp": "2025-09-05T14:40:22.217845Z",
"transaction_date": "2025-09-05T14:40:22.217862Z",
"txid": "1276T31G7T623GTYU123GJTY123JGTY",
"updated_at": "2025-09-05T14:40:22.217876Z",
"virtual_account_id": "01991a52-40c9-7991-1916-6dabb24a7f99"
}
}
Cancel collection by ID
Collection ID
Cancel collection params with ID
Cancellation reason
Entity ID
Requester Tax Number
Collection
Unprocessable Entity
Unprocessable Entity
POST /banking/cashin/pix/recurrences/collections/{id}/cancel HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"cancellation_reason": "Cancelled due to...",
"entity_id": "01991a52-43b6-942f-46e3-488c332fe873",
"requester_tax_number": "14633666800"
}
{
"data": {
"aditional_info": "ADITIONAL INFO",
"amount": {
"amount": 10,
"currency": "BRL"
},
"bank_account_id": "01991a52-40c9-ef5d-62a4-9b7b8983a6f7",
"company_id": "01991a52-40c9-a202-3901-1c5edc193541",
"counterparty_info_id": "01991a52-40c9-e96f-bf1d-e9006437946e",
"entity_id": "01991a52-40c9-6dec-ced6-92fe6c7642f9",
"final_date": "2025-09-05T14:40:22.217863Z",
"id": "01991a52-40c9-1caa-1706-5087be66c3a9",
"inserted_at": "2025-09-05T14:40:22.217874Z",
"next_working_day": "2025-09-05T14:40:22.217864Z",
"org_id": "01991a52-40c9-53fe-23b3-49a2adb289ff",
"recurrence_id": "01991a52-40c9-386c-0c5f-c52e5b8078de",
"recurrence_timestamp": "2025-09-05T14:40:22.217860Z",
"status": "created",
"timestamp": "2025-09-05T14:40:22.217845Z",
"transaction_date": "2025-09-05T14:40:22.217862Z",
"txid": "1276T31G7T623GTYU123GJTY123JGTY",
"updated_at": "2025-09-05T14:40:22.217876Z",
"virtual_account_id": "01991a52-40c9-7991-1916-6dabb24a7f99"
}
}
Schedule collection
Unique identifier
Schedule update params
Collection Amount in cents. Use it for updating the collection amount before scheduling. Does not work on recurrences with fixed amount.
No Content
No Content
Unprocessable Entity
Unprocessable Entity
POST /banking/cashin/pix/recurrences/collections/{id}/schedule HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"amount": 10000
}
No Content
Get recurrence request
Unique identifier
Unique identifier
Unique identifier
Unique identifier
Load stages?
Request
Unprocessable Entity
Unprocessable Entity
GET /banking/cashin/pix/recurrences/requests/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
"data": {
"counterparty_bank_account_id": "01991a52-4146-b25d-cb53-3b7b76b852a1",
"counterparty_id": "01991a52-4146-2cc8-1a97-3a6c8699ba08",
"counterparty_seq": 1,
"expiration_date": "2025-09-05T14:40:22.342185Z",
"id": "01991a52-4146-c9f8-4647-6ea279a69b28",
"id_solic_rec": "1234567890",
"inserted_at": "2025-09-05T14:40:22.342188Z",
"recurrence_id": "01991a52-4146-75c3-1757-5c6a9c1a9d13",
"recurrence_timestamp": "2025-09-05T14:40:22.342184Z",
"status": "created",
"timestamp": "2025-09-05T14:40:22.342175Z",
"updated_at": "2025-09-05T14:40:22.342189Z"
}
}
Get recurrence with stages
Recurrence Id
Entity Id
Bank Account Id
Virtual account Id
Load stages?
Load requests?
Recurrence
Unprocessable Entity
Unprocessable Entity
GET /banking/cashin/pix/recurrences/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*
{
"data": {
"counterparty_bank_account_id": "01993eeb-91c1-84fd-e379-d0f19197429a",
"start_date": "2025-09-12T17:14:09.729614Z",
"counterparty_id": "01993eeb-91c1-0a3a-b551-9c0cac215310",
"inserted_at": "2025-09-12T17:14:09.729622Z",
"type": "in",
"entity_id": "01993eeb-91c1-d5f3-aa77-f01662f1ed19",
"reference_id": "01993eeb-91c1-2eff-6b1d-822b966eca96",
"approval_type": "qrdn",
"minimum_amount": {
"amount": 10,
"currency": "BRL"
},
"ispb": "19947272",
"first_payment_date": "2025-09-12T17:14:09.729612Z",
"virtual_account_id": "01993eeb-91c1-0a35-4e98-a9c66ad7788c",
"number_of_collections": 10,
"company_id": "01993eeb-91c1-b047-0ecf-920da858f939",
"automatic_schedule": false,
"end_date": "2025-09-12T17:14:09.729615Z",
"status": "approved",
"updated_at": "2025-09-12T17:14:09.729623Z",
"next_working_day": true,
"description": "Descrição da recorrência",
"id": "01993eeb-91c1-31bf-4733-fafce541d685",
"id_rec": "01993eeb-91c1-a3c1-f123-dcbc348d99fd",
"fixed_amount": {
"amount": 10,
"currency": "BRL"
},
"contract_number": "123",
"txid": "HASHJDFHJASDJHFUU23E1287317823",
"journey": "aut1",
"external_id": "Teste 1",
"authorization_date": "2025-09-12T17:14:09.729618Z",
"retry_policy": "none",
"timestamp": "2025-09-12T17:14:09.729570Z",
"origin_id": "01993eeb-91c1-a0b5-044a-9e7186877d7a",
"org_id": "01993eeb-91c1-a39d-6ed2-9b39947f33e7",
"first_payment_amount": {
"amount": 10,
"currency": "BRL"
},
"maximum_amount": {
"amount": 10,
"currency": "BRL"
},
"periodicity": "week",
"origin_type": "api_client",
"update_date": "2025-09-12T17:14:09.729617Z",
"bank_account_id": "01993eeb-91c1-c963-b73a-518bbba56179",
"counterparty_info_id": "01993eeb-91c1-c86b-7130-02a851d4f4bf",
"counterparty_seq": "12"
}
}
Cancel recurrence by ID
Recurrence ID
Cancel recurrence params with ID
Cancellation reason
Requester Tax Number
Recurrence
Unprocessable Entity
Unprocessable Entity
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": "01993eeb-91c1-84fd-e379-d0f19197429a",
"start_date": "2025-09-12T17:14:09.729614Z",
"counterparty_id": "01993eeb-91c1-0a3a-b551-9c0cac215310",
"inserted_at": "2025-09-12T17:14:09.729622Z",
"type": "in",
"entity_id": "01993eeb-91c1-d5f3-aa77-f01662f1ed19",
"reference_id": "01993eeb-91c1-2eff-6b1d-822b966eca96",
"approval_type": "qrdn",
"minimum_amount": {
"amount": 10,
"currency": "BRL"
},
"ispb": "19947272",
"first_payment_date": "2025-09-12T17:14:09.729612Z",
"virtual_account_id": "01993eeb-91c1-0a35-4e98-a9c66ad7788c",
"number_of_collections": 10,
"company_id": "01993eeb-91c1-b047-0ecf-920da858f939",
"automatic_schedule": false,
"end_date": "2025-09-12T17:14:09.729615Z",
"status": "approved",
"updated_at": "2025-09-12T17:14:09.729623Z",
"next_working_day": true,
"description": "Descrição da recorrência",
"id": "01993eeb-91c1-31bf-4733-fafce541d685",
"id_rec": "01993eeb-91c1-a3c1-f123-dcbc348d99fd",
"fixed_amount": {
"amount": 10,
"currency": "BRL"
},
"contract_number": "123",
"txid": "HASHJDFHJASDJHFUU23E1287317823",
"journey": "aut1",
"external_id": "Teste 1",
"authorization_date": "2025-09-12T17:14:09.729618Z",
"retry_policy": "none",
"timestamp": "2025-09-12T17:14:09.729570Z",
"origin_id": "01993eeb-91c1-a0b5-044a-9e7186877d7a",
"org_id": "01993eeb-91c1-a39d-6ed2-9b39947f33e7",
"first_payment_amount": {
"amount": 10,
"currency": "BRL"
},
"maximum_amount": {
"amount": 10,
"currency": "BRL"
},
"periodicity": "week",
"origin_type": "api_client",
"update_date": "2025-09-12T17:14:09.729617Z",
"bank_account_id": "01993eeb-91c1-c963-b73a-518bbba56179",
"counterparty_info_id": "01993eeb-91c1-c86b-7130-02a851d4f4bf",
"counterparty_seq": "12"
}
}
Was this helpful?