{ "openapi": "3.0.3", "info": { "title": "Scheduling", "version": "1.0.0", "description": "Portão 3 scheduling API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Confidence tiers: generated:typed=7 copied:manual=0 unknown=0." }, "servers": [ { "url": "https://api.scheduling.v2.portao3.com.br/", "description": "production" }, { "url": "https://api.scheduling.dev.3pers.com.br/", "description": "development" } ], "x-p3-surface": "public", "tags": [ { "name": "Schedules" } ], "components": {}, "paths": { "/realms/{realmId}/organizations/{organizationId}/schedules": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdSchedules", "summary": "List organization schedules", "tags": [ "Schedules" ], "x-p3-sidebar-order": 1, "description": "Lists every schedule of the organization, across all of its wallets, newest first.", "x-mint": { "content": "Only an organization admin can list them. Filter by status, payment type, due date or description. A list filter takes its values comma-separated (`?status=SCHEDULED,FAILED`); repeating the parameter (`?status=SCHEDULED&status=FAILED`) works too. Paginated — see [Pagination](/api-reference/pagination)." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "description": "ID of your realm.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b" }, { "name": "organizationId", "in": "path", "required": true, "description": "ID of the organization whose schedules you want to list.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "c4bd3f21-dfbd-44e8-8055-68ba15bed410" }, { "name": "status", "in": "query", "required": false, "description": "Only schedules in one of these statuses.\n\n---\n\nExample (comma-separated list): `?status=SCHEDULED,FAILED`", "schema": { "type": "array", "items": { "type": "string", "enum": [ "SCHEDULED", "PROCESSING", "CANCELLED", "FAILED", "DONE" ] } }, "style": "form", "explode": false }, { "name": "transactionTypes", "in": "query", "required": false, "description": "Only schedules of one of these payment types.\n\n---\n\nExample (comma-separated list): `?transactionTypes=PIX_TRANSFER,BANK_SLIP_PAYMENT`", "schema": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP_PAYMENT", "PIX_PAYMENT", "P2P_TRANSFER", "PIX_TRANSFER" ] } }, "style": "form", "explode": false }, { "name": "description", "in": "query", "required": false, "description": "Only schedules whose description contains this text (case-insensitive).", "schema": { "type": "string", "maxLength": 256 }, "example": "Rent" }, { "name": "scheduledAtStart", "in": "query", "required": false, "description": "Only schedules due at or after this instant (ISO 8601 date-time).", "schema": { "type": "string", "format": "date-time" }, "example": "2026-11-01T03:00:00.000Z" }, { "name": "scheduledAtEnd", "in": "query", "required": false, "description": "Only schedules due at or before this instant (ISO 8601 date-time). Must not be earlier than `scheduledAtStart`.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-11-30T02:59:59.999Z" }, { "name": "next", "in": "query", "required": false, "description": "Cursor returned as `next` by the previous page. Omit for the first page.", "schema": { "type": "string" }, "example": "6716f0a2c9e77b0012a4d5e1" }, { "name": "limit", "in": "query", "required": false, "description": "Page size.", "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "example": 50 } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the schedule.", "example": "3b9f7c2e-5d41-4e8a-9a6f-1c2d3e4f5a6b", "format": "uuid" }, "amount": { "type": "number", "description": "Amount to pay, in cents (BRL).", "example": 150000 }, "scheduledAt": { "type": "string", "format": "date-time", "description": "When the payment is due to run.", "example": "2026-11-05T03:00:00.000Z" }, "type": { "type": "string", "enum": [ "BANK_SLIP_PAYMENT", "PIX_PAYMENT", "P2P_TRANSFER", "PIX_TRANSFER" ], "description": "What the schedule pays: a Pix to a key (`PIX_TRANSFER`), a Pix QR code (`PIX_PAYMENT`), a bank slip (`BANK_SLIP_PAYMENT`) or a transfer to another wallet of the same account (`P2P_TRANSFER`).", "example": "PIX_TRANSFER" }, "status": { "type": "string", "enum": [ "SCHEDULED", "PROCESSING", "CANCELLED", "FAILED", "DONE" ], "description": "Where the schedule is: waiting for its day (`SCHEDULED`), running (`PROCESSING`), paid (`DONE`), failed (`FAILED`) or cancelled (`CANCELLED`).", "example": "SCHEDULED" }, "description": { "type": "string", "description": "Description given when the schedule was created.", "example": "Office rent — November" }, "organization": { "type": "string", "description": "ID of the organization the schedule belongs to.", "example": "c4bd3f21-dfbd-44e8-8055-68ba15bed410", "format": "uuid" }, "retryCount": { "type": "number", "nullable": true, "description": "Number of execution attempts that failed. Absent or `null` before any failure.", "example": null }, "realm": { "type": "string", "description": "ID of the realm the schedule belongs to.", "example": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b", "format": "uuid" }, "account": { "type": "string", "description": "ID of the account that pays.", "example": "6702b1e4a9c3d80012f4a7b1" }, "wallet": { "type": "string", "description": "ID of the wallet that pays.", "example": "6702b1e4a9c3d80012f4a7b5" }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "Balance category of the wallet the amount is taken from.", "example": "FLEX_NATIONAL" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the schedule was created.", "example": "2026-10-20T14:32:10.512Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the schedule was last changed.", "example": "2026-10-20T14:32:10.512Z" }, "createdBy": { "type": "string", "description": "ID of the user who created the schedule.", "example": "e3553bc1-5e20-4e17-b22a-a796fda0aa99" }, "updatedBy": { "type": "string", "description": "ID of the user who last changed the schedule.", "example": "e3553bc1-5e20-4e17-b22a-a796fda0aa99" }, "cancelledBy": { "type": "string", "description": "ID of the user who cancelled the schedule. Present only on a cancelled schedule.", "example": "e3553bc1-5e20-4e17-b22a-a796fda0aa99" }, "cancelledAt": { "type": "string", "format": "date-time", "description": "When the schedule was cancelled. Present only on a cancelled schedule.", "example": "2026-10-22T11:05:41.207Z" } }, "required": [ "id", "amount", "scheduledAt", "type", "status", "organization", "realm", "account", "wallet", "createdAt", "updatedAt", "createdBy", "updatedBy" ], "description": "A scheduled payment." }, "description": "The schedules of this page." }, "next": { "type": "string", "nullable": true, "description": "Cursor of the next page — send it as `next`. `null` on the last page.", "example": "6716f0a2c9e77b0012a4d5e1" } }, "required": [ "items", "next" ], "description": "A page of schedules, newest first." } } } }, "403": { "description": "`SCHEDULING_ADMIN_REQUIRED` — Only organization admins can list the schedules of the organization.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "SCHEDULING_ADMIN_REQUIRED" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "SCHEDULING_ADMIN_REQUIRED", "origin": "SCHEDULING", "message": "Organization admin required" } } } }, "422": { "description": "`BAD_REQUEST` — A path or query parameter is invalid; `fields` lists each one.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "BAD_REQUEST" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." }, "fields": { "type": "array", "description": "One entry per invalid request field (validation errors only).", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Path of the invalid field, e.g. `label` or `values[0].value`.", "example": "label" }, "message": { "type": "string", "description": "Why the field was rejected.", "example": "label is required" }, "code": { "type": "string", "description": "`_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.", "example": "LABEL_REQUIRED" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The accepted values, when the field is an enumeration." } }, "required": [ "field", "message", "code" ] } } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "BAD_REQUEST", "origin": "SCHEDULING", "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.", "fields": [ { "field": "description", "message": "Too big: expected string to have <=256 characters", "code": "DESCRIPTION_MAX" } ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value); `.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdSchedules", "summary": "List wallet schedules", "tags": [ "Schedules" ], "x-p3-sidebar-order": 2, "description": "Lists the schedules a wallet pays, newest first.", "x-mint": { "content": "Only an organization admin can list them. Filter by status, payment type, due date or description. A list filter takes its values comma-separated (`?status=SCHEDULED,FAILED`); repeating the parameter (`?status=SCHEDULED&status=FAILED`) works too. Each item is the schedule alone — get a schedule to read the payment behind it. Paginated — see [Pagination](/api-reference/pagination)." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "description": "ID of your realm.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b" }, { "name": "organizationId", "in": "path", "required": true, "description": "ID of the organization the wallet belongs to.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "c4bd3f21-dfbd-44e8-8055-68ba15bed410" }, { "name": "accountId", "in": "path", "required": true, "description": "ID of the account (24 hexadecimal characters).", "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$" }, "example": "6702b1e4a9c3d80012f4a7b1" }, { "name": "walletId", "in": "path", "required": true, "description": "ID of the wallet whose schedules you want to list (24 hexadecimal characters).", "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$" }, "example": "6702b1e4a9c3d80012f4a7b5" }, { "name": "status", "in": "query", "required": false, "description": "Only schedules in one of these statuses.\n\n---\n\nExample (comma-separated list): `?status=SCHEDULED,FAILED`", "schema": { "type": "array", "items": { "type": "string", "enum": [ "SCHEDULED", "PROCESSING", "CANCELLED", "FAILED", "DONE" ] } }, "style": "form", "explode": false }, { "name": "transactionTypes", "in": "query", "required": false, "description": "Only schedules of one of these payment types.\n\n---\n\nExample (comma-separated list): `?transactionTypes=PIX_TRANSFER,BANK_SLIP_PAYMENT`", "schema": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP_PAYMENT", "PIX_PAYMENT", "P2P_TRANSFER", "PIX_TRANSFER" ] } }, "style": "form", "explode": false }, { "name": "description", "in": "query", "required": false, "description": "Only schedules whose description contains this text (case-insensitive).", "schema": { "type": "string", "maxLength": 256 }, "example": "Rent" }, { "name": "scheduledAtStart", "in": "query", "required": false, "description": "Only schedules due at or after this instant (ISO 8601 date-time).", "schema": { "type": "string", "format": "date-time" }, "example": "2026-11-01T03:00:00.000Z" }, { "name": "scheduledAtEnd", "in": "query", "required": false, "description": "Only schedules due at or before this instant (ISO 8601 date-time). Must not be earlier than `scheduledAtStart`.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-11-30T02:59:59.999Z" }, { "name": "next", "in": "query", "required": false, "description": "Cursor returned as `next` by the previous page. Omit for the first page.", "schema": { "type": "string" }, "example": "6716f0a2c9e77b0012a4d5e1" }, { "name": "limit", "in": "query", "required": false, "description": "Page size.", "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "example": 50 } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the schedule.", "example": "3b9f7c2e-5d41-4e8a-9a6f-1c2d3e4f5a6b", "format": "uuid" }, "amount": { "type": "number", "description": "Amount to pay, in cents (BRL).", "example": 150000 }, "scheduledAt": { "type": "string", "format": "date-time", "description": "When the payment is due to run.", "example": "2026-11-05T03:00:00.000Z" }, "type": { "type": "string", "enum": [ "BANK_SLIP_PAYMENT", "PIX_PAYMENT", "P2P_TRANSFER", "PIX_TRANSFER" ], "description": "What the schedule pays: a Pix to a key (`PIX_TRANSFER`), a Pix QR code (`PIX_PAYMENT`), a bank slip (`BANK_SLIP_PAYMENT`) or a transfer to another wallet of the same account (`P2P_TRANSFER`).", "example": "PIX_TRANSFER" }, "status": { "type": "string", "enum": [ "SCHEDULED", "PROCESSING", "CANCELLED", "FAILED", "DONE" ], "description": "Where the schedule is: waiting for its day (`SCHEDULED`), running (`PROCESSING`), paid (`DONE`), failed (`FAILED`) or cancelled (`CANCELLED`).", "example": "SCHEDULED" }, "description": { "type": "string", "description": "Description given when the schedule was created.", "example": "Office rent — November" }, "organization": { "type": "string", "description": "ID of the organization the schedule belongs to.", "example": "c4bd3f21-dfbd-44e8-8055-68ba15bed410", "format": "uuid" }, "retryCount": { "type": "number", "nullable": true, "description": "Number of execution attempts that failed. Absent or `null` before any failure.", "example": null }, "realm": { "type": "string", "description": "ID of the realm the schedule belongs to.", "example": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b", "format": "uuid" }, "account": { "type": "string", "description": "ID of the account that pays.", "example": "6702b1e4a9c3d80012f4a7b1" }, "wallet": { "type": "string", "description": "ID of the wallet that pays.", "example": "6702b1e4a9c3d80012f4a7b5" }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "Balance category of the wallet the amount is taken from.", "example": "FLEX_NATIONAL" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the schedule was created.", "example": "2026-10-20T14:32:10.512Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the schedule was last changed.", "example": "2026-10-20T14:32:10.512Z" }, "createdBy": { "type": "string", "description": "ID of the user who created the schedule.", "example": "e3553bc1-5e20-4e17-b22a-a796fda0aa99" }, "updatedBy": { "type": "string", "description": "ID of the user who last changed the schedule.", "example": "e3553bc1-5e20-4e17-b22a-a796fda0aa99" }, "cancelledBy": { "type": "string", "description": "ID of the user who cancelled the schedule. Present only on a cancelled schedule.", "example": "e3553bc1-5e20-4e17-b22a-a796fda0aa99" }, "cancelledAt": { "type": "string", "format": "date-time", "description": "When the schedule was cancelled. Present only on a cancelled schedule.", "example": "2026-10-22T11:05:41.207Z" } }, "required": [ "id", "amount", "scheduledAt", "type", "status", "organization", "realm", "account", "wallet", "createdAt", "updatedAt", "createdBy", "updatedBy" ], "description": "A scheduled payment." }, "description": "The schedules of this page." }, "next": { "type": "string", "nullable": true, "description": "Cursor of the next page — send it as `next`. `null` on the last page.", "example": "6716f0a2c9e77b0012a4d5e1" } }, "required": [ "items", "next" ], "description": "A page of schedules, newest first." } } } }, "403": { "description": "`SCHEDULING_ADMIN_REQUIRED` — Only organization admins can read the schedules of a wallet.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "SCHEDULING_ADMIN_REQUIRED" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "SCHEDULING_ADMIN_REQUIRED", "origin": "SCHEDULING", "message": "Organization admin required" } } } }, "422": { "description": "`BAD_REQUEST` — A path or query parameter is invalid; `fields` lists each one.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "BAD_REQUEST" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." }, "fields": { "type": "array", "description": "One entry per invalid request field (validation errors only).", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Path of the invalid field, e.g. `label` or `values[0].value`.", "example": "label" }, "message": { "type": "string", "description": "Why the field was rejected.", "example": "label is required" }, "code": { "type": "string", "description": "`_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.", "example": "LABEL_REQUIRED" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The accepted values, when the field is an enumeration." } }, "required": [ "field", "message", "code" ] } } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "BAD_REQUEST", "origin": "SCHEDULING", "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.", "fields": [ { "field": "description", "message": "Too big: expected string to have <=256 characters", "code": "DESCRIPTION_MAX" } ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value); `.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdSchedulesByScheduleId", "summary": "Get a schedule", "tags": [ "Schedules" ], "x-p3-sidebar-order": 3, "description": "Returns a schedule and the payment behind it.", "x-mint": { "content": "`additionalInfos` is read live from the payment when you ask: the Pix or bank slip as it stands now (amounts, due date, who pays and who receives), or the receiving wallet of a transfer between wallets. Use the schedule's `status` to know whether it already ran. Only an organization admin can read it." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "description": "ID of your realm.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b" }, { "name": "organizationId", "in": "path", "required": true, "description": "ID of the organization the wallet belongs to.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "c4bd3f21-dfbd-44e8-8055-68ba15bed410" }, { "name": "accountId", "in": "path", "required": true, "description": "ID of the account (24 hexadecimal characters).", "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$" }, "example": "6702b1e4a9c3d80012f4a7b1" }, { "name": "walletId", "in": "path", "required": true, "description": "ID of the wallet the schedule pays from (24 hexadecimal characters).", "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$" }, "example": "6702b1e4a9c3d80012f4a7b5" }, { "name": "scheduleId", "in": "path", "required": true, "description": "ID of the schedule.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "3b9f7c2e-5d41-4e8a-9a6f-1c2d3e4f5a6b" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the schedule.", "example": "3b9f7c2e-5d41-4e8a-9a6f-1c2d3e4f5a6b", "format": "uuid" }, "amount": { "type": "number", "description": "Amount to pay, in cents (BRL).", "example": 150000 }, "scheduledAt": { "type": "string", "format": "date-time", "description": "When the payment is due to run.", "example": "2026-11-05T03:00:00.000Z" }, "type": { "type": "string", "enum": [ "BANK_SLIP_PAYMENT", "PIX_PAYMENT", "P2P_TRANSFER", "PIX_TRANSFER" ], "description": "What the schedule pays: a Pix to a key (`PIX_TRANSFER`), a Pix QR code (`PIX_PAYMENT`), a bank slip (`BANK_SLIP_PAYMENT`) or a transfer to another wallet of the same account (`P2P_TRANSFER`).", "example": "PIX_TRANSFER" }, "status": { "type": "string", "enum": [ "SCHEDULED", "PROCESSING", "CANCELLED", "FAILED", "DONE" ], "description": "Where the schedule is: waiting for its day (`SCHEDULED`), running (`PROCESSING`), paid (`DONE`), failed (`FAILED`) or cancelled (`CANCELLED`).", "example": "SCHEDULED" }, "description": { "type": "string", "description": "Description given when the schedule was created.", "example": "Office rent — November" }, "organization": { "type": "string", "description": "ID of the organization the schedule belongs to.", "example": "c4bd3f21-dfbd-44e8-8055-68ba15bed410", "format": "uuid" }, "retryCount": { "type": "number", "nullable": true, "description": "Number of execution attempts that failed. Absent or `null` before any failure.", "example": null }, "realm": { "type": "string", "description": "ID of the realm the schedule belongs to.", "example": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b", "format": "uuid" }, "account": { "type": "string", "description": "ID of the account that pays.", "example": "6702b1e4a9c3d80012f4a7b1" }, "wallet": { "type": "string", "description": "ID of the wallet that pays.", "example": "6702b1e4a9c3d80012f4a7b5" }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "Balance category of the wallet the amount is taken from.", "example": "FLEX_NATIONAL" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the schedule was created.", "example": "2026-10-20T14:32:10.512Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the schedule was last changed.", "example": "2026-10-20T14:32:10.512Z" }, "createdBy": { "type": "string", "description": "ID of the user who created the schedule.", "example": "e3553bc1-5e20-4e17-b22a-a796fda0aa99" }, "updatedBy": { "type": "string", "description": "ID of the user who last changed the schedule.", "example": "e3553bc1-5e20-4e17-b22a-a796fda0aa99" }, "cancelledBy": { "type": "string", "description": "ID of the user who cancelled the schedule. Present only on a cancelled schedule.", "example": "e3553bc1-5e20-4e17-b22a-a796fda0aa99" }, "cancelledAt": { "type": "string", "format": "date-time", "description": "When the schedule was cancelled. Present only on a cancelled schedule.", "example": "2026-10-22T11:05:41.207Z" }, "additionalInfos": { "type": "object", "properties": { "currency": { "type": "string", "nullable": true, "description": "Currency of the payment.", "example": "BRL" }, "allowAmountChange": { "type": "boolean", "description": "Whether the payment accepts an amount different from the one it was issued with.", "example": false }, "discountAmount": { "type": "number", "nullable": true, "description": "Discount applied, in cents.", "example": null }, "interestAmount": { "type": "number", "nullable": true, "description": "Interest added, in cents.", "example": null }, "fineAmount": { "type": "number", "nullable": true, "description": "Fine added, in cents.", "example": null }, "originalAmount": { "type": "number", "nullable": true, "description": "Amount the payment was issued with, in cents.", "example": 150000 }, "amount": { "type": "number", "nullable": true, "description": "Amount to pay, in cents.", "example": 150000 }, "description": { "type": "string", "nullable": true, "description": "Description of the payment.", "example": "Office rent — November" }, "dueDate": { "description": "Due date of the payment.", "example": null, "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true, "description": "Status of the underlying Pix or bank slip (`null` for a transfer between wallets).", "example": "REQUESTED" }, "expiresAt": { "description": "When the payment stops being payable.", "example": null, "type": "string", "format": "date-time", "nullable": true }, "confirmedAmount": { "type": "number", "nullable": true, "description": "Amount actually paid, in cents.", "example": null }, "payee": { "type": "string", "nullable": true, "description": "Name of who receives the payment.", "example": "Imobiliária Exemplo Ltda" }, "payeeDocument": { "type": "string", "nullable": true, "description": "CPF or CNPJ of who receives the payment, digits only.", "example": "12345678000190" }, "payer": { "type": "string", "nullable": true, "description": "Name of who pays.", "example": "Empresa Exemplo S.A." }, "payerDocument": { "type": "string", "nullable": true, "description": "CPF or CNPJ of who pays, digits only.", "example": "98765432000110" }, "bankSlip": { "type": "object", "properties": { "digitableLine": { "type": "string", "nullable": true, "description": "Digitable line of the bank slip.", "example": "23793381286000000000900000000000184340000150000" }, "minAmount": { "type": "number", "nullable": true, "description": "Lowest amount the bank slip accepts, in cents.", "example": null }, "maxAmount": { "type": "number", "nullable": true, "description": "Highest amount the bank slip accepts, in cents.", "example": null }, "issuer": { "type": "string", "nullable": true, "description": "Bank that issued the bank slip.", "example": "Banco Exemplo S.A." }, "type": { "type": "string", "nullable": true, "description": "Kind of bank slip.", "example": "GENERIC" } }, "required": [ "digitableLine", "minAmount", "maxAmount", "issuer", "type" ], "description": "The bank slip. Present when `type` is `BANK_SLIP_PAYMENT`." }, "pix": { "type": "object", "properties": { "endToEndId": { "type": "string", "nullable": true, "description": "End-to-end ID of the Pix, once it was paid.", "example": null }, "transactionType": { "type": "string", "nullable": true, "description": "Kind of Pix transaction.", "example": "TRANSFER" }, "withdrawalAmount": { "type": "number", "nullable": true, "description": "Withdrawal amount of a Pix Saque, in cents.", "example": null }, "pixCopyPaste": { "type": "string", "nullable": true, "description": "The Pix copy-and-paste code (EMV) of a QR-code payment.", "example": null }, "qrCodeType": { "type": "string", "nullable": true, "description": "Kind of QR code paid by a `PIX_PAYMENT` schedule.", "example": null }, "pixKey": { "type": "string", "nullable": true, "description": "Pix key of the receiver.", "example": "financeiro@imobiliariaexemplo.com.br" }, "purchaseAmount": { "type": "number", "nullable": true, "description": "Purchase amount of a Pix Troco, in cents.", "example": null }, "initiationType": { "type": "string", "nullable": true, "description": "How the Pix was started.", "example": "DICT" }, "creditParty": { "type": "object", "properties": { "bankIspb": { "type": "string", "nullable": true, "description": "ISPB code of the receiver's bank.", "example": "60701190" }, "document": { "type": "string", "nullable": true, "description": "CPF or CNPJ of the receiver, digits only.", "example": "12345678000190" }, "name": { "type": "string", "nullable": true, "description": "Name of the receiver.", "example": "Imobiliária Exemplo Ltda" } }, "required": [ "bankIspb", "document", "name" ], "description": "Who receives the Pix." }, "debitParty": { "type": "object", "properties": { "accountNumber": { "type": "string", "nullable": true, "description": "Number of the paying account.", "example": "123456" }, "accountType": { "type": "string", "nullable": true, "description": "Type of the paying account.", "example": "CACC" }, "bankIspb": { "type": "string", "nullable": true, "description": "ISPB code of the paying bank.", "example": "13140088" }, "branch": { "type": "string", "nullable": true, "description": "Branch of the paying account.", "example": "0001" }, "document": { "type": "string", "nullable": true, "description": "CPF or CNPJ of the payer, digits only.", "example": "98765432000110" }, "name": { "type": "string", "nullable": true, "description": "Name of the payer.", "example": "Empresa Exemplo S.A." } }, "required": [ "accountNumber", "accountType", "bankIspb", "branch", "document", "name" ], "description": "The account the Pix is paid from." } }, "required": [ "endToEndId", "transactionType", "withdrawalAmount", "pixCopyPaste", "qrCodeType", "pixKey", "purchaseAmount", "initiationType", "creditParty", "debitParty" ], "description": "The Pix. Present when `type` is `PIX_TRANSFER` or `PIX_PAYMENT`." }, "p2pTransfer": { "type": "object", "properties": { "payeeRealmId": { "type": "string", "description": "ID of the receiver's realm.", "example": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b" }, "payeeOrganizationId": { "type": "string", "description": "ID of the receiver's organization.", "example": "c4bd3f21-dfbd-44e8-8055-68ba15bed410" }, "payeeWalletId": { "type": "string", "description": "ID of the receiving wallet.", "example": "6702b1e4a9c3d80012f4a7b9" }, "payeeAccountId": { "type": "string", "description": "ID of the receiver's account.", "example": "6702b1e4a9c3d80012f4a7b1" }, "payeeCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "Balance category the amount is credited to.", "example": "FLEX_NATIONAL" } }, "required": [ "payeeRealmId", "payeeOrganizationId", "payeeWalletId", "payeeAccountId", "payeeCategory" ], "description": "The receiving wallet. Present when `type` is `P2P_TRANSFER`." } }, "required": [ "currency", "allowAmountChange", "discountAmount", "interestAmount", "fineAmount", "originalAmount", "amount", "description", "dueDate", "status", "expiresAt", "confirmedAmount", "payee", "payeeDocument", "payer", "payerDocument" ], "description": "The payment behind the schedule." } }, "required": [ "account", "additionalInfos", "amount", "createdAt", "createdBy", "id", "organization", "realm", "scheduledAt", "status", "type", "updatedAt", "updatedBy", "wallet" ], "description": "A scheduled payment, with the payment behind it." } } } }, "403": { "description": "`SCHEDULING_ADMIN_REQUIRED` — Only organization admins can read the schedules of a wallet.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "SCHEDULING_ADMIN_REQUIRED" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "SCHEDULING_ADMIN_REQUIRED", "origin": "SCHEDULING", "message": "Organization admin required" } } } }, "404": { "description": "`TRANSACTION_SCHEDULE_NOT_FOUND` — No schedule with this ID pays from this wallet.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "TRANSACTION_SCHEDULE_NOT_FOUND" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "TRANSACTION_SCHEDULE_NOT_FOUND", "origin": "SCHEDULING", "message": "Transaction schedule not found" } } } }, "422": { "description": "`BAD_REQUEST` — A path parameter is not a valid ID; `fields` lists each one.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "BAD_REQUEST" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." }, "fields": { "type": "array", "description": "One entry per invalid request field (validation errors only).", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Path of the invalid field, e.g. `label` or `values[0].value`.", "example": "label" }, "message": { "type": "string", "description": "Why the field was rejected.", "example": "label is required" }, "code": { "type": "string", "description": "`_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.", "example": "LABEL_REQUIRED" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The accepted values, when the field is an enumeration." } }, "required": [ "field", "message", "code" ] } } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "BAD_REQUEST", "origin": "SCHEDULING", "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.", "fields": [ { "field": "scheduleId", "message": "Invalid UUID", "code": "SCHEDULEID_UUID" } ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/logs": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdSchedulesByScheduleIdLogs", "summary": "List schedule events", "tags": [ "Schedules" ], "x-p3-sidebar-order": 4, "description": "Lists what happened to a schedule, newest first.", "x-mint": { "content": "The schedule's history: when it was created, changed or cancelled, each execution attempt and its outcome — with the error code of a failure and the IDs of what a successful run created — and when the customer was notified. Only an organization admin can read it. Filter by kind of event. Paginated — see [Pagination](/api-reference/pagination)." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "description": "ID of your realm.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b" }, { "name": "organizationId", "in": "path", "required": true, "description": "ID of the organization the wallet belongs to.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "c4bd3f21-dfbd-44e8-8055-68ba15bed410" }, { "name": "accountId", "in": "path", "required": true, "description": "ID of the account (24 hexadecimal characters).", "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$" }, "example": "6702b1e4a9c3d80012f4a7b1" }, { "name": "walletId", "in": "path", "required": true, "description": "ID of the wallet the schedule pays from (24 hexadecimal characters).", "schema": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$" }, "example": "6702b1e4a9c3d80012f4a7b5" }, { "name": "scheduleId", "in": "path", "required": true, "description": "ID of the schedule.\n\nFormat: `UUID`", "schema": { "type": "string", "format": "uuid" }, "example": "3b9f7c2e-5d41-4e8a-9a6f-1c2d3e4f5a6b" }, { "name": "events", "in": "query", "required": false, "description": "Only events of these kinds.\n\n---\n\nExample (comma-separated list): `?events=EXECUTION_SUCCESS,EXECUTION_FAILED`", "schema": { "type": "array", "items": { "type": "string", "enum": [ "CREATED", "EXECUTION_TRY", "EXECUTION_FAILED", "EXECUTION_SUCCESS", "UPDATED", "CANCELLED", "NOTIFIED" ] } }, "style": "form", "explode": false }, { "name": "next", "in": "query", "required": false, "description": "Cursor returned as `next` by the previous page. Omit for the first page.", "schema": { "type": "string" }, "example": "6719a0c4d8e1a30012b7c9fb" }, { "name": "limit", "in": "query", "required": false, "description": "Page size.", "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "example": 50 } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the event.", "example": "8d2b6a4e-1f3c-4b5d-9e7f-0a1b2c3d4e5f", "format": "uuid" }, "transactionSchedule": { "type": "string", "description": "ID of the schedule.", "example": "3b9f7c2e-5d41-4e8a-9a6f-1c2d3e4f5a6b", "format": "uuid" }, "event": { "type": "string", "enum": [ "CREATED", "EXECUTION_TRY", "EXECUTION_FAILED", "EXECUTION_SUCCESS", "UPDATED", "CANCELLED", "NOTIFIED" ], "description": "What happened: created (`CREATED`), changed (`UPDATED`), cancelled (`CANCELLED`), an execution started (`EXECUTION_TRY`), succeeded (`EXECUTION_SUCCESS`) or failed (`EXECUTION_FAILED`), or the customer was notified (`NOTIFIED`).", "example": "EXECUTION_SUCCESS" }, "failureCode": { "type": "string", "description": "Error code of a failed execution.", "example": "INSUFFICIENT_FUNDS" }, "details": { "type": "string", "description": "Human-readable account of the event.", "example": "Execution try initiated" }, "references": { "description": "IDs of what a successful execution created.", "type": "object", "properties": { "initiationId": { "type": "string", "description": "ID of the payment initiation (Pix or bank slip).", "example": "6719a0c4d8e1a30012b7c9f2" }, "pixId": { "type": "string", "description": "ID of the Pix that paid the schedule.", "example": "6719a0c4d8e1a30012b7c9f2" }, "bankSlipId": { "type": "string", "description": "ID of the bank slip payment that paid the schedule.", "example": "6719a0c4d8e1a30012b7c9f7" }, "transferId": { "type": "string", "description": "ID of the transfer between wallets that paid the schedule.", "example": "6719a0c4d8e1a30012b7c9f9" } }, "nullable": true }, "performedAt": { "type": "string", "format": "date-time", "description": "When it happened.", "example": "2026-11-05T11:30:04.118Z" }, "performedBy": { "type": "string", "description": "ID of the user who did it, or `system` for an automatic step.", "example": "system" } }, "required": [ "id", "transactionSchedule", "event", "performedAt", "performedBy" ], "description": "Something that happened to a schedule." }, "description": "The events of this page." }, "next": { "type": "string", "nullable": true, "description": "Cursor of the next page — send it as `next`. `null` on the last page.", "example": "6719a0c4d8e1a30012b7c9fb" } }, "required": [ "items", "next" ], "description": "A page of a schedule's events, newest first." } } } }, "403": { "description": "`SCHEDULING_ADMIN_REQUIRED` — Only organization admins can read the schedules of a wallet.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "SCHEDULING_ADMIN_REQUIRED" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "SCHEDULING_ADMIN_REQUIRED", "origin": "SCHEDULING", "message": "Organization admin required" } } } }, "404": { "description": "`TRANSACTION_SCHEDULE_NOT_FOUND` — No schedule with this ID pays from this wallet.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "TRANSACTION_SCHEDULE_NOT_FOUND" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "TRANSACTION_SCHEDULE_NOT_FOUND", "origin": "SCHEDULING", "message": "Transaction schedule not found" } } } }, "422": { "description": "`BAD_REQUEST` — A path or query parameter is invalid; `fields` lists each one.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "BAD_REQUEST" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "SCHEDULING" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." }, "fields": { "type": "array", "description": "One entry per invalid request field (validation errors only).", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Path of the invalid field, e.g. `label` or `values[0].value`.", "example": "label" }, "message": { "type": "string", "description": "Why the field was rejected.", "example": "label is required" }, "code": { "type": "string", "description": "`_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.", "example": "LABEL_REQUIRED" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The accepted values, when the field is an enumeration." } }, "required": [ "field", "message", "code" ] } } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "BAD_REQUEST", "origin": "SCHEDULING", "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.", "fields": [ { "field": "limit", "message": "Too big: expected number to be <=100", "code": "LIMIT_MAX" } ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "note": "`.refine(…)` constraint not represented (runtime-dependent value)" } } } } }