GET/payments/requests/{requestId}/automatic-pix/schedules/{paymentId}

Obtenha um pagamento PIX agendado automaticamente

Recupera um pagamento PIX automático agendado pelo id

Parameters

Path Parameters

Name	Type	Description
`requestId`required	string (uuid)	Identificador primário da solicitação de pagamento
`paymentId`required	string (uuid)	Identificador principal de pagamento agendado automático do PIX

Responses

200Recupera um pagamento PIX automático agendado pelo id

object

Detalhe do pagamento automático PIX com campos adicionais

All of:

part 1object

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

clientPaymentIdstring

Identificador externo para o pagamento

recipientIdrequiredstring (uuid)

Identificador do destinatário do pagamento

isFirstPaymentboolean

Indica se este é o primeiro pagamento

attemptsobject[]

part 2object

scheduledStatusReachedrequiredboolean

Indicates whether the payment reached the scheduled status in the last attempt. Useful to determine if a retry can be executed.

Example response

json

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

curl -X GET \
  'https://api.pluggy.ai/payments/requests/{requestId}/automatic-pix/schedules/{paymentId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Resposta de exemplo

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