--- title: "Schedule Automatic PIX payment" method: POST path: "/payments/requests/{id}/automatic-pix/schedule" tags: ["Automatic PIX"] --- # Schedule Automatic PIX payment `POST /payments/requests/{id}/automatic-pix/schedule` Schedules an Automatic PIX payment ## Path parameters - `id` string, uuid, required ## Request body - ScheduleAutomaticPixPaymentRequest — Request to schedule an Automatic PIX payment - `amount` number, required — Transaction value - `description` string — Transaction description - `date` string, date, required — The payment date, which must fall between D+2 and D+10. Date format must be YYYY-MM-DD (for example: 2025-06-16) - `clientPaymentId` string — External identifier for the payment - `recipientId` string, uuid — Payment recipient identifier. It should be sent if you want to use a different recipient from the one consented in the payment request (it must have the same tax number as the consented recipient). ## Response `200` Schedule a Automatic PIX payment. - AutomaticPixPayment — Automatic PIX payment - `id` string, required — Payment primary identifier - `status` 'SCHEDULED' | 'CREATED' | 'COMPLETED' | 'CANCELED' | 'ERROR', required — Status of an individual recurring PIX payment. - `SCHEDULED`: the payment has been scheduled at the institution. - `CREATED`: the payment is created and pending execution. - `COMPLETED`: the payment was confirmed. - `CANCELED`: the payment was canceled. - `ERROR`: the payment failed (see `errorDetail`). - `amount` number, required — Payment amount - `description` string — Payment description - `date` string, date, required — Payment scheduled date - `endToEndId` string — Payment end to end identifier - `errorDetail` AutomaticPixPaymentErrorDetail — Details about an error that occurred with the automatic PIX payment - `code` 'SALDO_INSUFICIENTE' | 'VALOR_ACIMA_LIMITE' | 'VALOR_INVALIDO' | 'NAO_INFORMADO' | 'PAGAMENTO_DIVERGENTE_CONSENTIMENTO' | 'PAGAMENTO_RECUSADO_DETENTORA' | 'PAGAMENTO_RECUSADO_SPI' | 'CONSENTIMENTO_INVALIDO' | 'FALHA_INFRAESTRUTURA_SPI' | 'FALHA_INFRAESTRUTURA_ICP' | 'FALHA_INFRAESTRUTURA_PSP_RECEBEDOR' | 'FALHA_INFRAESTRUTURA_DETENTORA' | 'TITULARIDADE_INCONSISTENTE' | 'LIMITE_PERIODO_VALOR_EXCEDIDO' | 'LIMITE_PERIODO_QUANTIDADE_EXCEDIDO' | 'LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO' | 'LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO' | 'LIMITE_TENTATIVAS_EXCEDIDO' | 'CONSENTIMENTO_REVOGADO' | 'FORA_PRAZO_PERMITIDO' | 'DETALHE_TENTATIVA_INVALIDO' | 'DETALHE_PAGAMENTO_INVALIDO', required — Error codes expected during payment processing: - SALDO_INSUFICIENTE: The selected account does not have sufficient balance to make the payment. - VALOR_ACIMA_LIMITE: Validates if the amount exceeds the limit established [by the institution (account or channel)/in the arrangement] to allow the client to perform transactions. - VALOR_INVALIDO: The submitted amount is not valid. - NAO_INFORMADO: Not reported/identified by the account-holding institution. - PAGAMENTO_DIVERGENTE_CONSENTIMENTO: Payment data differs from consent data. - PAGAMENTO_RECUSADO_DETENTORA: [description of the reason for refusal]. - PAGAMENTO_RECUSADO_SPI: [error code according to PACS.002 reason domain table]. - CONSENTIMENTO_INVALIDO: Invalid consent (in final status). - FALHA_INFRAESTRUTURA_SPI: Indicates a failure in the Instant Payments System (SPI). - FALHA_INFRAESTRUTURA_ICP: Indicates a failure in the Public Key Infrastructure (ICP). - FALHA_INFRAESTRUTURA_PSP_RECEBEDOR: Indicates a failure in the infrastructure of the Payment Service Provider (PSP) that receives the payment. - FALHA_INFRAESTRUTURA_DETENTORA: Indicates a failure in the infrastructure of the institution holding the information or resources. - TITULARIDADE_INCONSISTENTE: Account currently not associated with the CPF/CNPJ of the long-term consent. - LIMITE_PERIODO_VALOR_EXCEDIDO: The transaction cannot be performed because the amount parameterized in the consent has been exceeded. - LIMITE_PERIODO_QUANTIDADE_EXCEDIDO: The transaction cannot be performed because the quantity parameterized in the consent has been exceeded. - LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO: The transaction amount exceeds the global consent limit. - LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO: The transaction amount exceeds the per-transaction limit set in the consent. - LIMITE_TENTATIVAS_EXCEDIDO: The maximum number of settlement attempts allowed by the arrangement has been reached. - CONSENTIMENTO_REVOGADO: The payment was associated with a consent that has been revoked. - FORA_PRAZO_PERMITIDO: The request time or period does not allow scheduling by the holder. - DETALHE_TENTATIVA_INVALIDO: The parameter(s) [field_name(s)] entered for the new payment attempt do not match the original failed payment and are not allowed in the new attempt. - DETALHE_PAGAMENTO_INVALIDO: Validates if a given parameter provided complies with the business rules. - `detail` string, required — Additional details about the error - `clientPaymentId` string — External identifier for the payment - `recipientId` string, uuid, required — Payment recipient identifier - `isFirstPayment` boolean — Indicates if this is the first payment - `attempts` AutomaticPixPaymentAttempt[] - `id` string, required — Attempt primary identifier - `status` 'IN_PROGRESS' | 'COMPLETED' | 'CANCELED' | 'ERROR', required — Attempt status. Each attempt has an independent lifecycle within the parent payment. - `IN_PROGRESS`: the attempt was submitted and is awaiting confirmation. - `COMPLETED`: the attempt was confirmed (the parent payment also becomes `COMPLETED`). - `CANCELED`: the attempt was canceled. - `ERROR`: the attempt failed (see `errorDetail`). The parent payment may be retried with a new attempt. - `endToEndId` string — Attempt end to end identifier - `date` string, date, required — Attempt date - `errorDetail` AutomaticPixPaymentErrorDetail — Details about an error that occurred with the automatic PIX payment - `code` 'SALDO_INSUFICIENTE' | 'VALOR_ACIMA_LIMITE' | 'VALOR_INVALIDO' | 'NAO_INFORMADO' | 'PAGAMENTO_DIVERGENTE_CONSENTIMENTO' | 'PAGAMENTO_RECUSADO_DETENTORA' | 'PAGAMENTO_RECUSADO_SPI' | 'CONSENTIMENTO_INVALIDO' | 'FALHA_INFRAESTRUTURA_SPI' | 'FALHA_INFRAESTRUTURA_ICP' | 'FALHA_INFRAESTRUTURA_PSP_RECEBEDOR' | 'FALHA_INFRAESTRUTURA_DETENTORA' | 'TITULARIDADE_INCONSISTENTE' | 'LIMITE_PERIODO_VALOR_EXCEDIDO' | 'LIMITE_PERIODO_QUANTIDADE_EXCEDIDO' | 'LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO' | 'LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO' | 'LIMITE_TENTATIVAS_EXCEDIDO' | 'CONSENTIMENTO_REVOGADO' | 'FORA_PRAZO_PERMITIDO' | 'DETALHE_TENTATIVA_INVALIDO' | 'DETALHE_PAGAMENTO_INVALIDO', required — Error codes expected during payment processing: - SALDO_INSUFICIENTE: The selected account does not have sufficient balance to make the payment. - VALOR_ACIMA_LIMITE: Validates if the amount exceeds the limit established [by the institution (account or channel)/in the arrangement] to allow the client to perform transactions. - VALOR_INVALIDO: The submitted amount is not valid. - NAO_INFORMADO: Not reported/identified by the account-holding institution. - PAGAMENTO_DIVERGENTE_CONSENTIMENTO: Payment data differs from consent data. - PAGAMENTO_RECUSADO_DETENTORA: [description of the reason for refusal]. - PAGAMENTO_RECUSADO_SPI: [error code according to PACS.002 reason domain table]. - CONSENTIMENTO_INVALIDO: Invalid consent (in final status). - FALHA_INFRAESTRUTURA_SPI: Indicates a failure in the Instant Payments System (SPI). - FALHA_INFRAESTRUTURA_ICP: Indicates a failure in the Public Key Infrastructure (ICP). - FALHA_INFRAESTRUTURA_PSP_RECEBEDOR: Indicates a failure in the infrastructure of the Payment Service Provider (PSP) that receives the payment. - FALHA_INFRAESTRUTURA_DETENTORA: Indicates a failure in the infrastructure of the institution holding the information or resources. - TITULARIDADE_INCONSISTENTE: Account currently not associated with the CPF/CNPJ of the long-term consent. - LIMITE_PERIODO_VALOR_EXCEDIDO: The transaction cannot be performed because the amount parameterized in the consent has been exceeded. - LIMITE_PERIODO_QUANTIDADE_EXCEDIDO: The transaction cannot be performed because the quantity parameterized in the consent has been exceeded. - LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO: The transaction amount exceeds the global consent limit. - LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO: The transaction amount exceeds the per-transaction limit set in the consent. - LIMITE_TENTATIVAS_EXCEDIDO: The maximum number of settlement attempts allowed by the arrangement has been reached. - CONSENTIMENTO_REVOGADO: The payment was associated with a consent that has been revoked. - FORA_PRAZO_PERMITIDO: The request time or period does not allow scheduling by the holder. - DETALHE_TENTATIVA_INVALIDO: The parameter(s) [field_name(s)] entered for the new payment attempt do not match the original failed payment and are not allowed in the new attempt. - DETALHE_PAGAMENTO_INVALIDO: Validates if a given parameter provided complies with the business rules. - `detail` string, required — Additional details about the error --- [API](https://skmtc.dev/pluggy/apis/pluggy-api.md) · [All operations](https://skmtc.dev/pluggy/apis/pluggy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pluggy/pluggy-api/revisions/75e87ec7f9cd/schema)