HomeBlogLoginSignup

Recurrences

List recurrences

get
/banking/cashin/pix/recurrences

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
/banking/cashin/pix/recurrences
GET /banking/cashin/pix/recurrences?from_datetime=2025-10-31T00%3A12%3A50.329Z&to_datetime=2025-10-31T00%3A12%3A50.329Z HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "counterparty_bank_account_id": "019a10fa-03e6-bc4f-b3a2-b153392dae99",
      "start_date": "2025-10-23T12:10:11.814596Z",
      "counterparty_id": "019a10fa-03e6-7f29-aa5a-d9e3d12d3f78",
      "inserted_at": "2025-10-23T12:10:11.814601Z",
      "type": "in",
      "entity_id": "019a10fa-03e6-f4a2-b36b-6f18e7edd674",
      "reference_id": "019a10fa-03e6-55b4-29f4-2f842b9df5bd",
      "approval_type": "qrdn",
      "minimum_amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "ispb": "19947272",
      "first_payment_date": "2025-10-23T12:10:11.814594Z",
      "virtual_account_id": "019a10fa-03e6-48bb-006f-98eeb12f2690",
      "number_of_collections": 10,
      "company_id": "019a10fa-03e6-7151-f83a-b8df784663ba",
      "automatic_schedule": false,
      "end_date": "2025-10-23T12:10:11.814597Z",
      "status": "approved",
      "updated_at": "2025-10-23T12:10:11.814602Z",
      "next_working_day": true,
      "description": "Descrição da recorrência",
      "id": "019a10fa-03e6-6e4f-0963-89a5c37e0975",
      "id_rec": "019a10fa-03e6-78e0-f6bd-c6e3152918d9",
      "fixed_amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "contract_number": "123",
      "txid": "HASHJDFHJASDJHFUU23E1287317823",
      "journey": "aut1",
      "external_id": "Teste 1",
      "authorization_date": "2025-10-23T12:10:11.814600Z",
      "retry_policy": "none",
      "timestamp": "2025-10-23T12:10:11.814580Z",
      "origin_id": "019a10fa-03e6-2e23-f998-63cec909bc8a",
      "org_id": "019a10fa-03e6-cab6-165f-1c6479579dbc",
      "first_payment_amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "maximum_amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "periodicity": "week",
      "origin_type": "api_client",
      "update_date": "2025-10-23T12:10:11.814599Z",
      "bank_account_id": "019a10fa-03e6-f669-f28d-de37bbf81eba",
      "counterparty_info_id": "019a10fa-03e6-4664-4918-879aa1b2772a",
      "counterparty_seq": "12"
    }
  ]
}

Generate a recurrence

post
/banking/cashin/pix/recurrences

Generate a recurrence

Body

GenerateRecurrenceParameters

contract_numberstring · max: 35Required

Contract Number

descriptionstring · max: 35Required

Description

end_datestring · date-time | nullableOptional

Recurrence End Date

external_idstring | nullableOptional

Recurrence External ID

periodicitystring · enumRequired

'week': every week, 'mnth': every month, 'qurt': every 3 months, 'mian': every 6 months, 'year': every year

Possible values:
start_datestring · date-timeRequired

Recurrence Start Date

virtual_account_idstring · uuidRequired

Virtual Account ID

Responses
201

Generate Recurrence Response

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

{
  "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": 100,
    "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-10-23",
      "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,
    "qrcode_expiration_seconds": 86400,
    "retry_policy": "3r_7d"
  },
  "periodicity": "mnth",
  "start_date": "2025-10-23T12:10:13.280326Z",
  "virtual_account_id": "019a10fa-09a0-c412-6d7f-2108ab8538d9"
}
{
  "data": {
    "counterparty_bank_account_id": "019a10fa-07a2-ccf5-119a-97110148a5ae",
    "start_date": "2025-10-23T12:10:12.770638Z",
    "counterparty_id": "019a10fa-07a2-53c4-e238-1f0e6ac43c5a",
    "type": "in",
    "entity_id": "019a10fa-07a2-8ca5-06c7-85d5aa797d2c",
    "reference_id": "019a10fa-07a2-8792-463f-f1b6c740b306",
    "minimum_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "ispb": "19947272",
    "first_payment_date": "2025-10-23T12:10:12.770636Z",
    "virtual_account_id": "019a10fa-07a2-647f-0a9e-8bff8ae63d97",
    "company_id": "019a10fa-07a2-6cba-6591-a9a6184ff3b0",
    "automatic_schedule": false,
    "end_date": "2025-10-23T12:10:12.770639Z",
    "status": "approved",
    "next_working_day": true,
    "description": "Descrição da recorrência",
    "id": "019a10fa-07a2-44f4-754e-a4ff5d8a72a8",
    "id_rec": "019a10fa-07a2-2e66-d76e-756004b7b742",
    "fixed_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "contract_number": "123",
    "txid": "HASHEDER3E1287317823",
    "journey": "aut1",
    "external_id": "Teste 1",
    "retry_policy": "none",
    "timestamp": "2025-10-23T12:10:12.770618Z",
    "org_id": "019a10fa-07a2-fa69-0939-14dc33735706",
    "first_payment_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "maximum_amount": {
      "amount": 10,
      "currency": "BRL"
    },
    "reference_type": "qrdn",
    "periodicity": "week",
    "qrcode": {
      "hash": "0000BResdasadjvajsidunajkTTrioTecnologia",
      "id": "019a10fa-07a2-b63c-6aae-0d39a61ee054",
      "type": "dynamic"
    },
    "bank_account_id": "019a10fa-07a2-549b-f872-b1dddccf6696",
    "counterparty_info_id": "019a10fa-07a2-c8f1-d664-51c797b4c53a",
    "counterparty_seq": "12"
  }
}

List recurrence collections

get
/banking/cashin/pix/recurrences/collections

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
/banking/cashin/pix/recurrences/collections
GET /banking/cashin/pix/recurrences/collections?recurrence_id=123e4567-e89b-12d3-a456-426614174000&from_datetime=2025-10-31T00%3A12%3A50.329Z&to_datetime=2025-10-31T00%3A12%3A50.329Z HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "aditional_info": "ADITIONAL INFO",
      "amount": {
        "amount": 10,
        "currency": "BRL"
      },
      "bank_account_id": "019a10fa-03e3-fe5b-dc51-e4df0b9924ec",
      "company_id": "019a10fa-03e3-124d-01c7-dc6be69288b5",
      "counterparty_info_id": "019a10fa-03e3-9229-9626-ad1fd4c9320a",
      "entity_id": "019a10fa-03e3-90bd-e32a-f38adf81fe79",
      "final_date": "2025-10-23T12:10:11.811401Z",
      "id": "019a10fa-03e3-6c11-009b-e6a0c30b2b00",
      "inserted_at": "2025-10-23T12:10:11.811412Z",
      "next_working_day": "2025-10-23T12:10:11.811402Z",
      "org_id": "019a10fa-03e3-6c82-aa1a-770ae1766936",
      "recurrence_id": "019a10fa-03e3-c18d-aeff-fe434f8120e5",
      "recurrence_timestamp": "2025-10-23T12:10:11.811397Z",
      "status": "created",
      "timestamp": "2025-10-23T12:10:11.811382Z",
      "transaction_date": "2025-10-23T12:10:11.811399Z",
      "txid": "1276T31G7T623GTYU123GJTY123JGTY",
      "updated_at": "2025-10-23T12:10:11.811414Z",
      "virtual_account_id": "019a10fa-03e3-f937-3cc1-d695e9e4cc4f"
    }
  ]
}

List recurrence collection's attempt

get
/banking/cashin/pix/recurrences/collections/attempts

List recurrence collection's attempt

Query parameters
entity_idstring · uuidOptional

Unique identifier

recurrence_idstring · uuidRequired

Unique identifier

collection_idstring · uuidRequired

Unique identifier

from_datetimestring · date-timeOptional

Datetime schema

to_datetimestring · date-timeOptional

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

Collection

application/json
get
/banking/cashin/pix/recurrences/collections/attempts
GET /banking/cashin/pix/recurrences/collections/attempts?recurrence_id=123e4567-e89b-12d3-a456-426614174000&collection_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "collection_id": "019a10fa-03e5-09bc-5dd9-40dd50214136",
      "collection_timestamp": "2025-10-23T12:10:11.813508Z",
      "due_date": "2025-10-23T12:10:11.813510Z",
      "end_to_end_id": "E123123124120510240124BJJHBVGHBJGHBJHKNJ",
      "external_id": "external id 1",
      "id": "019a10fa-03e5-98f6-333e-756654d24e27",
      "inserted_at": "2025-10-23T12:10:11.813511Z",
      "status": "created",
      "timestamp": "2025-10-23T12:10:11.813499Z",
      "transaction_date": "2025-10-23T12:10:11.813509Z",
      "txid": "1276T31G7T623GTYU123GJTY123JGTY",
      "type": "type",
      "updated_at": "2025-10-23T12:10:11.813513Z"
    }
  ]
}

Get recurrence collection attempt

get
/banking/cashin/pix/recurrences/collections/attempts/{id}

Get recurrence collection attempt

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
entity_idstring · uuidOptional

Unique identifier

load_stagesbooleanOptional

Load stages?

Responses
200

Collection

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

{
  "data": {
    "collection_id": "019a10fa-03e5-09bc-5dd9-40dd50214136",
    "collection_timestamp": "2025-10-23T12:10:11.813508Z",
    "due_date": "2025-10-23T12:10:11.813510Z",
    "end_to_end_id": "E123123124120510240124BJJHBVGHBJGHBJHKNJ",
    "external_id": "external id 1",
    "id": "019a10fa-03e5-98f6-333e-756654d24e27",
    "inserted_at": "2025-10-23T12:10:11.813511Z",
    "status": "created",
    "timestamp": "2025-10-23T12:10:11.813499Z",
    "transaction_date": "2025-10-23T12:10:11.813509Z",
    "txid": "1276T31G7T623GTYU123GJTY123JGTY",
    "type": "type",
    "updated_at": "2025-10-23T12:10:11.813513Z"
  }
}

Create next collection

post
/banking/cashin/pix/recurrences/collections/create_next_collection

Create next collection

Body

Create NextCollection params

recurrence_idstring · uuidRequired

Recurrence ID

Responses
200

Collection

application/json
post
/banking/cashin/pix/recurrences/collections/create_next_collection
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": "019a10fa-09f4-e055-c0b4-bdf688a9abaf"
}
{
  "data": {
    "aditional_info": "",
    "amount": {
      "amount": 0,
      "currency": ""
    },
    "attempts": [
      {
        "collection_id": "019a10fa-03e5-09bc-5dd9-40dd50214136",
        "collection_timestamp": "2025-10-23T12:10:11.813508Z",
        "due_date": "2025-10-23T12:10:11.813510Z",
        "end_to_end_id": "E123123124120510240124BJJHBVGHBJGHBJHKNJ",
        "external_id": "external id 1",
        "id": "019a10fa-03e5-98f6-333e-756654d24e27",
        "inserted_at": "2025-10-23T12:10:11.813511Z",
        "status": "created",
        "timestamp": "2025-10-23T12:10:11.813499Z",
        "transaction_date": "2025-10-23T12:10:11.813509Z",
        "txid": "1276T31G7T623GTYU123GJTY123JGTY",
        "type": "type",
        "updated_at": "2025-10-23T12:10:11.813513Z"
      }
    ],
    "bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "company_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "counterparty_info_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "final_date": "",
    "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "inserted_at": "",
    "next_working_day": "",
    "org_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "recurrence_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "recurrence_timestamp": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "stages": [
      {
        "amount": {
          "amount": 1000,
          "currency": "BRL"
        },
        "bank_account_id": "019a10fa-06af-7b91-3211-be6facae65e3",
        "cancelation_code": "cancelation code",
        "cancelation_description": "Cancelation description",
        "cancelation_origin": "cancelation origin",
        "collection_id": "019a10fa-06af-e61f-9f81-b685e279e45b",
        "collection_timestamp": "2025-10-23T12:10:12.527281Z",
        "id": "019a10fa-06af-3cad-3e12-53126b3e05e5",
        "inserted_at": "2025-10-23T12:10:12.527285Z",
        "next_working_day": true,
        "rejection_code": "rejection code",
        "rejection_description": "Rejection description",
        "requester_tax_number": "12345678901",
        "status": "created",
        "timestamp": "2025-10-23T12:10:12.527264Z",
        "transaction_date": "2025-10-23T12:10:12.527282Z",
        "updated_at": "2025-10-23T12:10:12.527286Z",
        "virtual_account_id": "019a10fa-06af-f3b4-3c08-ceb04b96dc6f"
      }
    ],
    "status": "created",
    "timestamp": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "transaction_date": "",
    "txid": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "updated_at": "",
    "virtual_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6"
  }
}

Get recurrence collection

get
/banking/cashin/pix/recurrences/collections/{id}

Get recurrence collection

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
entity_idstring · uuidOptional

Unique identifier

bank_account_idstring · uuidOptional

Unique identifier

virtual_account_idstring · uuidOptional

Unique identifier

load_stagesbooleanOptional

Load stages?

load_attemptsbooleanOptional

Load attempts?

Responses
200

Collection

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

{
  "data": {
    "aditional_info": "",
    "amount": {
      "amount": 0,
      "currency": ""
    },
    "attempts": [
      {
        "collection_id": "019a10fa-03e5-09bc-5dd9-40dd50214136",
        "collection_timestamp": "2025-10-23T12:10:11.813508Z",
        "due_date": "2025-10-23T12:10:11.813510Z",
        "end_to_end_id": "E123123124120510240124BJJHBVGHBJGHBJHKNJ",
        "external_id": "external id 1",
        "id": "019a10fa-03e5-98f6-333e-756654d24e27",
        "inserted_at": "2025-10-23T12:10:11.813511Z",
        "status": "created",
        "timestamp": "2025-10-23T12:10:11.813499Z",
        "transaction_date": "2025-10-23T12:10:11.813509Z",
        "txid": "1276T31G7T623GTYU123GJTY123JGTY",
        "type": "type",
        "updated_at": "2025-10-23T12:10:11.813513Z"
      }
    ],
    "bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "company_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "counterparty_info_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "final_date": "",
    "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "inserted_at": "",
    "next_working_day": "",
    "org_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "recurrence_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "recurrence_timestamp": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "stages": [
      {
        "amount": {
          "amount": 1000,
          "currency": "BRL"
        },
        "bank_account_id": "019a10fa-06af-7b91-3211-be6facae65e3",
        "cancelation_code": "cancelation code",
        "cancelation_description": "Cancelation description",
        "cancelation_origin": "cancelation origin",
        "collection_id": "019a10fa-06af-e61f-9f81-b685e279e45b",
        "collection_timestamp": "2025-10-23T12:10:12.527281Z",
        "id": "019a10fa-06af-3cad-3e12-53126b3e05e5",
        "inserted_at": "2025-10-23T12:10:12.527285Z",
        "next_working_day": true,
        "rejection_code": "rejection code",
        "rejection_description": "Rejection description",
        "requester_tax_number": "12345678901",
        "status": "created",
        "timestamp": "2025-10-23T12:10:12.527264Z",
        "transaction_date": "2025-10-23T12:10:12.527282Z",
        "updated_at": "2025-10-23T12:10:12.527286Z",
        "virtual_account_id": "019a10fa-06af-f3b4-3c08-ceb04b96dc6f"
      }
    ],
    "status": "created",
    "timestamp": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "transaction_date": "",
    "txid": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "updated_at": "",
    "virtual_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6"
  }
}

Update collection Amount

put
/banking/cashin/pix/recurrences/collections/{id}

Update collection Amount by ID

Path parameters
idstringRequired

Collection ID

Body

Collection update params

amountintegerRequired

Updated amount

Responses
200

Collection

application/json
put
/banking/cashin/pix/recurrences/collections/{id}
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": "",
    "amount": {
      "amount": 0,
      "currency": ""
    },
    "attempts": [
      {
        "collection_id": "019a10fa-03e5-09bc-5dd9-40dd50214136",
        "collection_timestamp": "2025-10-23T12:10:11.813508Z",
        "due_date": "2025-10-23T12:10:11.813510Z",
        "end_to_end_id": "E123123124120510240124BJJHBVGHBJGHBJHKNJ",
        "external_id": "external id 1",
        "id": "019a10fa-03e5-98f6-333e-756654d24e27",
        "inserted_at": "2025-10-23T12:10:11.813511Z",
        "status": "created",
        "timestamp": "2025-10-23T12:10:11.813499Z",
        "transaction_date": "2025-10-23T12:10:11.813509Z",
        "txid": "1276T31G7T623GTYU123GJTY123JGTY",
        "type": "type",
        "updated_at": "2025-10-23T12:10:11.813513Z"
      }
    ],
    "bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "company_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "counterparty_info_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "final_date": "",
    "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "inserted_at": "",
    "next_working_day": "",
    "org_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "recurrence_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "recurrence_timestamp": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "stages": [
      {
        "amount": {
          "amount": 1000,
          "currency": "BRL"
        },
        "bank_account_id": "019a10fa-06af-7b91-3211-be6facae65e3",
        "cancelation_code": "cancelation code",
        "cancelation_description": "Cancelation description",
        "cancelation_origin": "cancelation origin",
        "collection_id": "019a10fa-06af-e61f-9f81-b685e279e45b",
        "collection_timestamp": "2025-10-23T12:10:12.527281Z",
        "id": "019a10fa-06af-3cad-3e12-53126b3e05e5",
        "inserted_at": "2025-10-23T12:10:12.527285Z",
        "next_working_day": true,
        "rejection_code": "rejection code",
        "rejection_description": "Rejection description",
        "requester_tax_number": "12345678901",
        "status": "created",
        "timestamp": "2025-10-23T12:10:12.527264Z",
        "transaction_date": "2025-10-23T12:10:12.527282Z",
        "updated_at": "2025-10-23T12:10:12.527286Z",
        "virtual_account_id": "019a10fa-06af-f3b4-3c08-ceb04b96dc6f"
      }
    ],
    "status": "created",
    "timestamp": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "transaction_date": "",
    "txid": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "updated_at": "",
    "virtual_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6"
  }
}

Cancel collection

post
/banking/cashin/pix/recurrences/collections/{id}/cancel

Cancel collection by ID

Path parameters
idstringRequired

Collection ID

Body

Cancel collection params with ID

entity_idstring · uuidOptional

Entity ID

requester_tax_numberstringRequired

Requester Tax Number

Responses
200

Collection

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

{
  "entity_id": "019a10fa-0806-39db-c8d7-34cdeb037060",
  "requester_tax_number": "14633666800"
}
{
  "data": {
    "aditional_info": "",
    "amount": {
      "amount": 0,
      "currency": ""
    },
    "attempts": [
      {
        "collection_id": "019a10fa-03e5-09bc-5dd9-40dd50214136",
        "collection_timestamp": "2025-10-23T12:10:11.813508Z",
        "due_date": "2025-10-23T12:10:11.813510Z",
        "end_to_end_id": "E123123124120510240124BJJHBVGHBJGHBJHKNJ",
        "external_id": "external id 1",
        "id": "019a10fa-03e5-98f6-333e-756654d24e27",
        "inserted_at": "2025-10-23T12:10:11.813511Z",
        "status": "created",
        "timestamp": "2025-10-23T12:10:11.813499Z",
        "transaction_date": "2025-10-23T12:10:11.813509Z",
        "txid": "1276T31G7T623GTYU123GJTY123JGTY",
        "type": "type",
        "updated_at": "2025-10-23T12:10:11.813513Z"
      }
    ],
    "bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "company_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "counterparty_info_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "final_date": "",
    "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "inserted_at": "",
    "next_working_day": "",
    "org_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "recurrence_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "recurrence_timestamp": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "stages": [
      {
        "amount": {
          "amount": 1000,
          "currency": "BRL"
        },
        "bank_account_id": "019a10fa-06af-7b91-3211-be6facae65e3",
        "cancelation_code": "cancelation code",
        "cancelation_description": "Cancelation description",
        "cancelation_origin": "cancelation origin",
        "collection_id": "019a10fa-06af-e61f-9f81-b685e279e45b",
        "collection_timestamp": "2025-10-23T12:10:12.527281Z",
        "id": "019a10fa-06af-3cad-3e12-53126b3e05e5",
        "inserted_at": "2025-10-23T12:10:12.527285Z",
        "next_working_day": true,
        "rejection_code": "rejection code",
        "rejection_description": "Rejection description",
        "requester_tax_number": "12345678901",
        "status": "created",
        "timestamp": "2025-10-23T12:10:12.527264Z",
        "transaction_date": "2025-10-23T12:10:12.527282Z",
        "updated_at": "2025-10-23T12:10:12.527286Z",
        "virtual_account_id": "019a10fa-06af-f3b4-3c08-ceb04b96dc6f"
      }
    ],
    "status": "created",
    "timestamp": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "transaction_date": "",
    "txid": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "updated_at": "",
    "virtual_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6"
  }
}

Schedule collection

post
/banking/cashin/pix/recurrences/collections/{id}/schedule

Schedule collection

Path parameters
idstring · uuidRequired

Unique identifier

Body

Schedule update params

amountintegerOptional

Collection Amount in cents. Use it for updating the collection amount before scheduling. Does not work on recurrences with fixed amount.

due_datestring · date-time | nullableOptional

attempt's due date

external_idstring | nullableOptional

attempt's external_id

Responses
204

No Content

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

{
  "amount": 10000,
  "due_date": "2025-10-23T12:10:13.039970Z",
  "external_id": "019a0be5-d593-7b33-161a-7611b3820a76"
}
No Content

Get recurrence request

get
/banking/cashin/pix/recurrences/requests/{id}

Get recurrence request

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
entity_idstring · uuidOptional

Unique identifier

bank_account_idstring · uuidOptional

Unique identifier

virtual_account_idstring · uuidOptional

Unique identifier

load_stagesbooleanOptional

Load stages?

Responses
200

Request

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

{
  "data": {
    "counterparty_bank_account_id": "019a10fa-046b-1f8f-731a-b768f21bb340",
    "counterparty_id": "019a10fa-046b-09b3-bd47-b038a6c8466c",
    "counterparty_seq": 1,
    "expiration_date": "2025-10-23T12:10:11.947747Z",
    "id": "019a10fa-046b-cf2e-7c48-bcfb4ab03bb1",
    "id_solic_rec": "1234567890",
    "inserted_at": "2025-10-23T12:10:11.947750Z",
    "recurrence_id": "019a10fa-046b-0416-7bf3-a083cba59b76",
    "recurrence_timestamp": "2025-10-23T12:10:11.947744Z",
    "status": "created",
    "timestamp": "2025-10-23T12:10:11.947719Z",
    "updated_at": "2025-10-23T12:10:11.947752Z"
  }
}

Get recurrence

get
/banking/cashin/pix/recurrences/{id}

Get recurrence with stages

Path parameters
idstring · uuidRequired

Recurrence Id

Query parameters
entity_idstring · uuidOptional

Entity Id

bank_account_idstring · uuidOptional

Bank Account Id

virtual_account_idstring · uuidOptional

Virtual account Id

load_stagesbooleanOptional

Load stages?

load_requestsbooleanOptional

Load requests?

Responses
200

Recurrence

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

{
  "data": {
    "counterparty_bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "start_date": "2020-04-20T16:20:00Z",
    "counterparty_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "stages": [
      {
        "cancelation_code": "cancelation_code_example",
        "cancelation_description": "Cancelation description example",
        "cancelation_origin": "cancelation_origin_example",
        "collection_id": "019a10fa-06ef-08d2-a394-ea9a005484cf",
        "collection_timestamp": "2025-10-23T12:10:12.591833Z",
        "error_code": "error_code_example",
        "error_message": "Error message example",
        "id": "019a10fa-06ef-8522-a2ec-37cf41523f92",
        "inserted_at": "2025-10-23T12:10:12.591834Z",
        "journey": "aut1",
        "recurrence_id": "019a10fa-06ef-eb59-059b-372ae866211f",
        "reference_id": "019a10fa-06ef-8150-249c-6e6d27b1c342",
        "reference_type": "qrdn",
        "rejection_code": "rejection_code_example",
        "rejection_description": "Rejection description example",
        "request_id": "019a10fa-06ef-eb1e-7903-97826fcbb11b",
        "request_timestamp": "2025-10-23T12:10:12.591831Z",
        "status": "approved",
        "timestamp": "2025-10-23T12:10:12.591815Z",
        "updated_at": "2025-10-23T12:10:12.591836Z",
        "virtual_account_id": "019a10fa-06ef-1b5b-400f-262f5ced80a1"
      }
    ],
    "inserted_at": "2020-04-20T16:20:00Z",
    "requests": [
      {
        "counterparty_bank_account_id": "019a10fa-046b-1f8f-731a-b768f21bb340",
        "counterparty_id": "019a10fa-046b-09b3-bd47-b038a6c8466c",
        "counterparty_seq": 1,
        "expiration_date": "2025-10-23T12:10:11.947747Z",
        "id": "019a10fa-046b-cf2e-7c48-bcfb4ab03bb1",
        "id_solic_rec": "1234567890",
        "inserted_at": "2025-10-23T12:10:11.947750Z",
        "recurrence_id": "019a10fa-046b-0416-7bf3-a083cba59b76",
        "recurrence_timestamp": "2025-10-23T12:10:11.947744Z",
        "status": "created",
        "timestamp": "2025-10-23T12:10:11.947719Z",
        "updated_at": "2025-10-23T12:10:11.947752Z"
      }
    ],
    "type": "in",
    "entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "reference_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "minimum_amount": {
      "amount": "",
      "currency": ""
    },
    "ispb": "",
    "first_payment_date": "2020-04-20T16:20:00Z",
    "virtual_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "number_of_collections": "",
    "company_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "automatic_schedule": "",
    "end_date": "2020-04-20T16:20:00Z",
    "status": "created",
    "updated_at": "2020-04-20T16:20:00Z",
    "next_working_day": "",
    "description": "",
    "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "id_rec": "",
    "fixed_amount": {
      "amount": "",
      "currency": ""
    },
    "contract_number": "",
    "txid": "",
    "journey": "aut1",
    "external_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "authorization_date": "2020-04-20T16:20:00Z",
    "retry_policy": "none",
    "timestamp": "",
    "origin_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "org_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "first_payment_amount": {
      "amount": "",
      "currency": ""
    },
    "maximum_amount": {
      "amount": "",
      "currency": ""
    },
    "reference_type": "requ",
    "periodicity": "week",
    "origin_type": "none",
    "update_date": "2020-04-20T16:20:00Z",
    "bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "counterparty_info_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "counterparty_seq": ""
  }
}

Cancel recurrence

post
/banking/cashin/pix/recurrences/{id}/cancel

Cancel recurrence by ID

Path parameters
idstringRequired

Recurrence ID

Body

Cancel recurrence params with ID

requester_tax_numberstringRequired

Requester Tax Number

Responses
200

Recurrence

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

{
  "requester_tax_number": "80617053000195"
}
{
  "data": {
    "counterparty_bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "start_date": "2020-04-20T16:20:00Z",
    "counterparty_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "stages": [
      {
        "cancelation_code": "cancelation_code_example",
        "cancelation_description": "Cancelation description example",
        "cancelation_origin": "cancelation_origin_example",
        "collection_id": "019a10fa-06ef-08d2-a394-ea9a005484cf",
        "collection_timestamp": "2025-10-23T12:10:12.591833Z",
        "error_code": "error_code_example",
        "error_message": "Error message example",
        "id": "019a10fa-06ef-8522-a2ec-37cf41523f92",
        "inserted_at": "2025-10-23T12:10:12.591834Z",
        "journey": "aut1",
        "recurrence_id": "019a10fa-06ef-eb59-059b-372ae866211f",
        "reference_id": "019a10fa-06ef-8150-249c-6e6d27b1c342",
        "reference_type": "qrdn",
        "rejection_code": "rejection_code_example",
        "rejection_description": "Rejection description example",
        "request_id": "019a10fa-06ef-eb1e-7903-97826fcbb11b",
        "request_timestamp": "2025-10-23T12:10:12.591831Z",
        "status": "approved",
        "timestamp": "2025-10-23T12:10:12.591815Z",
        "updated_at": "2025-10-23T12:10:12.591836Z",
        "virtual_account_id": "019a10fa-06ef-1b5b-400f-262f5ced80a1"
      }
    ],
    "inserted_at": "2020-04-20T16:20:00Z",
    "requests": [
      {
        "counterparty_bank_account_id": "019a10fa-046b-1f8f-731a-b768f21bb340",
        "counterparty_id": "019a10fa-046b-09b3-bd47-b038a6c8466c",
        "counterparty_seq": 1,
        "expiration_date": "2025-10-23T12:10:11.947747Z",
        "id": "019a10fa-046b-cf2e-7c48-bcfb4ab03bb1",
        "id_solic_rec": "1234567890",
        "inserted_at": "2025-10-23T12:10:11.947750Z",
        "recurrence_id": "019a10fa-046b-0416-7bf3-a083cba59b76",
        "recurrence_timestamp": "2025-10-23T12:10:11.947744Z",
        "status": "created",
        "timestamp": "2025-10-23T12:10:11.947719Z",
        "updated_at": "2025-10-23T12:10:11.947752Z"
      }
    ],
    "type": "in",
    "entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "reference_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "minimum_amount": {
      "amount": "",
      "currency": ""
    },
    "ispb": "",
    "first_payment_date": "2020-04-20T16:20:00Z",
    "virtual_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "number_of_collections": "",
    "company_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "automatic_schedule": "",
    "end_date": "2020-04-20T16:20:00Z",
    "status": "created",
    "updated_at": "2020-04-20T16:20:00Z",
    "next_working_day": "",
    "description": "",
    "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "id_rec": "",
    "fixed_amount": {
      "amount": "",
      "currency": ""
    },
    "contract_number": "",
    "txid": "",
    "journey": "aut1",
    "external_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "authorization_date": "2020-04-20T16:20:00Z",
    "retry_policy": "none",
    "timestamp": "",
    "origin_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "org_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "first_payment_amount": {
      "amount": "",
      "currency": ""
    },
    "maximum_amount": {
      "amount": "",
      "currency": ""
    },
    "reference_type": "requ",
    "periodicity": "week",
    "origin_type": "none",
    "update_date": "2020-04-20T16:20:00Z",
    "bank_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "counterparty_info_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
    "counterparty_seq": ""
  }
}
PreviousBoletosNextPayment

Last updated

Was this helpful?