POST/payments/requests/{id}/automatic-pix/schedule

Agendar pagamento automático via PIX

Agenda um pagamento automático de PIX

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Identificador primário da solicitação de pagamento

Request Body

required

object

Solicitação para agendar um pagamento automático via PIX

amountrequirednumber

Valor da transação

descriptionstring

Descrição da transação

daterequiredstring (date)

A data de pagamento deve estar entre D+2 e D+10. O formato da data deve ser YYYY-MM-DD (por exemplo: 2025-06-16)

clientPaymentIdstring

Identificador externo para o pagamento

recipientIdstring (uuid)

Identificador do destinatário do pagamento. Deve ser enviado se você quiser usar um destinatário diferente do que foi consentido na solicitação de pagamento (ele deve ter o mesmo número de identificação fiscal que o destinatário consentido).

Example

json

{
  "amount": 100.5,
  "date": "2025-06-10",
  "description": "Transferência",
  "clientPaymentId": "external-ref-456"
}

Responses

200Agende um pagamento automático via PIX.

object

Pagamento automático via PIX

idrequiredstring

Identificador primário de pagamento

statusrequiredstring

Status de um pagamento PIX recorrente individual. - `SCHEDULED`: o pagamento foi agendado na instituição. - `CREATED`: o pagamento foi criado e está pendente de execução. - `COMPLETED`: o pagamento foi confirmado. - `CANCELED`: o pagamento foi cancelado. - `ERROR`: o pagamento falhou (veja `errorDetail`).

SCHEDULEDCREATEDCOMPLETEDCANCELEDERROR

amountrequirednumber

Valor do pagamento

descriptionstring

Descrição do pagamento

daterequiredstring (date)

Data agendada para pagamento

endToEndIdstring | null

Identificador de pagamento de ponta a ponta

errorDetailobject | null

Any of:

option 1object

Detalhes sobre um erro que ocorreu com o pagamento automático via PIX

option 2null | null

clientPaymentIdstring

Identificador externo para o pagamento

recipientIdrequiredstring (uuid)

Identificador do destinatário do pagamento

isFirstPaymentboolean

Indica se este é o primeiro pagamento

attemptsobject[]

itemsobject

Tentativa de pagamento. Representa uma tentativa de concluir este pagamento. Útil para rastrear o histórico de pagamentos.

Example response

json

{
  "id": "66d503f1-0cfa-4d64-9f87-0782d959eba7",
  "recipientId": "3b8f2f2a-0f6e-4a6a-9d8f-7c2e1b4a5d6e",
  "status": "SCHEDULED",
  "amount": 0.01,
  "description": "Teste pagamento schedule",
  "endToEndId": null,
  "date": "2025-06-08",
  "errorDetail": null,
  "clientPaymentId": "external-ref-456",
  "isFirstPayment": false
}

curl -X POST \
  'https://api.pluggy.ai/payments/requests/{id}/automatic-pix/schedule' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{ "amount": 100.5, "date": "2025-06-10", "description": "Transferência", "clientPaymentId": "external-ref-456" }'

Resposta de exemplo

{
  "id": "66d503f1-0cfa-4d64-9f87-0782d959eba7",
  "recipientId": "3b8f2f2a-0f6e-4a6a-9d8f-7c2e1b4a5d6e",
  "status": "SCHEDULED",
  "amount": 0.01,
  "description": "Teste pagamento schedule",
  "endToEndId": null,
  "date": "2025-06-08",
  "errorDetail": null,
  "clientPaymentId": "external-ref-456",
  "isFirstPayment": false
}