Procurando a documentação anterior?Acesse v1.docs.pluggy.ai
PluggyDocs
GET/payments/intents/{id}

Recuperar

Recupera o recurso de intenção de pagamento pelo seu id

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Responses

200Recuperar uma intenção de pagamento.
object

Solicitação com informações relacionadas a uma intenção de pagamento

idrequiredstring

Identificador principal

statusrequiredstring

Ciclo de vida de uma intenção de pagamento. O fluxo vai da coleta de consentimento (CONSENT_*) à execução do pagamento (PAYMENT_*). **Fase de Consentimento** - `STARTED`: o processo de consentimento começou no Pluggy. - `ENQUEUED`: o pagamento está na fila aguardando o fluxo de consentimento ser iniciado. - `CONSENT_AWAITING_AUTHORIZATION`: o pagador deve completar a autorização na instituição (veja `consentUrl`). - `CONSENT_AUTHORIZED`: o consentimento foi concedido pelo pagador. - `CONSENT_REJECTED`: o consentimento foi rejeitado pelo pagador ou pela instituição. **Fase de Pagamento** - `PAYMENT_PENDING`: o pagamento foi enviado para a instituição e está aguardando confirmação. - `PAYMENT_PARTIALLY_ACCEPTED`: o pagamento foi aceito, mas ainda precisa de uma autorização adicional (por exemplo, contas com múltiplas assinaturas). - `PAYMENT_SETTLEMENT_PROCESSING`: a liquidação está sendo processada. - `PAYMENT_SETTLEMENT_DEBTOR_ACCOUNT`: os fundos foram debitados da conta do pagador; aguardando compensação. - `PAYMENT_COMPLETED`: o pagamento foi confirmado pela instituição. - `PAYMENT_REJECTED`: o pagamento foi rejeitado após o consentimento ser autorizado. **Terminal / outros** - `REJECTED`: status genérico de rejeição (razão específica da instituição em `errorDetail`). - `ERROR`: um erro inesperado ocorreu durante o fluxo. - `CANCELED`: a intenção foi cancelada. - `REVOKED`: o consentimento foi revogado após a autorização (apenas pagamentos recorrentes). - `CONSUMED`: o consentimento foi totalmente consumido (pagamentos recorrentes chegaram ao fim). - `PAYMENT_TIMEOUT`: a tentativa de autorização excedeu seu tempo limite. Tentativas de pagamento regulares expiram após 30 minutos; tentativas automáticas de PIX expiram após 60 minutos. A Solicitação de Pagamento retorna para `CREATED`.

STARTEDENQUEUEDCONSENT_AWAITING_AUTHORIZATIONCONSENT_AUTHORIZEDCONSENT_REJECTEDPAYMENT_PENDINGPAYMENT_PARTIALLY_ACCEPTEDPAYMENT_SETTLEMENT_PROCESSINGPAYMENT_SETTLEMENT_DEBTOR_ACCOUNTPAYMENT_COMPLETEDPAYMENT_REJECTEDREJECTEDERRORCANCELEDREVOKEDCONSUMEDPAYMENT_TIMEOUT
createdAtrequiredstring (date-time)

Data em que a intenção de pagamento foi criada

updatedAtrequiredstring (date-time)

Data em que a intenção de pagamento foi atualizada

paymentRequestobject

Solicitação de pagamento associada à intenção de pagamento

All of:
part 1object

Resposta com informações relacionadas a uma solicitação de pagamento

connectorobject

Conector associado à intenção de pagamento

All of:
part 1object

Objeto do conector

consentUrlstring

Url para autorizar a intenção de pagamento

referenceIdstring

ID do Pix relacionado à intenção de pagamento

paymentMethodstring

O método de pagamento pode ser PIS (Payment Initiation) ou PIX

PISPIX

Default: "PIS"

pixDataobject

Dados do Pix relacionados à intenção de pagamento (aplica-se apenas ao método de pagamento PIX)

All of:
part 1object

Dados da Intenção de Pagamento PIX

debtorobject | null

Informações sobre a conta do pagador, retornadas pela instituição após a conclusão do pagamento. Nulo até que a instituição a exponha.

Any of:
option 1object

Informações sobre a conta do pagador, conforme retornado pela instituição após a conclusão do pagamento. Apenas preenchido para intenções de pagamento `PAYMENT_COMPLETED` em conectores que expõem esses dados.

option 2null | null
errorDetailobject

Detalhes do erro quando a intenção de pagamento falha

All of:
part 1object

Detalhes sobre um erro que ocorreu com a intenção de pagamento

Example response

json
{
  "id": "4cfe1f6d-ae71-4c35-aae0-8f8a535ffbbd",
  "status": "CONSENT_AWAITING_AUTHORIZATION",
  "createdAt": "2023-11-06T15:38:47.861Z",
  "updatedAt": "2023-11-06T15:45:19.384Z",
  "paymentRequest": {
    "id": "c2a6b7d9-3349-435d-8341-44021449ebbc",
    "amount": 100.5,
    "description": "Transferência",
    "status": "IN_PROGRESS",
    "createdAt": "2023-11-06T13:03:45.689Z",
    "updatedAt": "2023-11-06T15:45:19.401Z",
    "callbackUrls": null,
    "recipient": null,
    "paymentUrl": "https://pay.pluggy.ai/05c693bf-c196-47ea-a28c-8251d6bb8a06",
    "isSandbox": false
  },
  "connector": {
    "id": 603,
    "name": "Bradesco",
    "primaryColor": "e5173f",
    "institutionUrl": "https://banco.bradesco/open-finance/logo/icones_vetorial-pf.svg",
    "country": "BR",
    "type": "PERSONAL_BANK",
    "credentials": [
      {
        "validation": "^\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}$",
        "validationMessage": "CPF deve ter 11 números.",
        "label": "CPF",
        "name": "cpf",
        "type": "number",
        "placeholder": "",
        "optional": false
      }
    ],
    "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/203.svg",
    "hasMFA": false,
    "oauth": true,
    "health": {
      "status": "ONLINE",
      "stage": null
    },
    "products": [
      "ACCOUNTS",
      "TRANSACTIONS",
      "IDENTITY",
      "CREDIT_CARDS",
      "PAYMENT_DATA",
      "LOANS",
      "INVESTMENTS"
    ],
    "createdAt": "2023-07-12T20:20:17.253Z",
    "isSandbox": false,
    "isOpenFinance": true
  },
  "consentUrl": "https://consenturl.com"
}
curl -X GET \
  'https://api.pluggy.ai/payments/intents/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{
  "id": "4cfe1f6d-ae71-4c35-aae0-8f8a535ffbbd",
  "status": "CONSENT_AWAITING_AUTHORIZATION",
  "createdAt": "2023-11-06T15:38:47.861Z",
  "updatedAt": "2023-11-06T15:45:19.384Z",
  "paymentRequest": {
    "id": "c2a6b7d9-3349-435d-8341-44021449ebbc",
    "amount": 100.5,
    "description": "Transferência",
    "status": "IN_PROGRESS",
    "createdAt": "2023-11-06T13:03:45.689Z",
    "updatedAt": "2023-11-06T15:45:19.401Z",
    "callbackUrls": null,
    "recipient": null,
    "paymentUrl": "https://pay.pluggy.ai/05c693bf-c196-47ea-a28c-8251d6bb8a06",
    "isSandbox": false
  },
  "connector": {
    "id": 603,
    "name": "Bradesco",
    "primaryColor": "e5173f",
    "institutionUrl": "https://banco.bradesco/open-finance/logo/icones_vetorial-pf.svg",
    "country": "BR",
    "type": "PERSONAL_BANK",
    "credentials": [
      {
        "validation": "^\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}$",
        "validationMessage": "CPF deve ter 11 números.",
        "label": "CPF",
        "name": "cpf",
        "type": "number",
        "placeholder": "",
        "optional": false
      }
    ],
    "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/203.svg",
    "hasMFA": false,
    "oauth": true,
    "health": {
      "status": "ONLINE",
      "stage": null
    },
    "products": [
      "ACCOUNTS",
      "TRANSACTIONS",
      "IDENTITY",
      "CREDIT_CARDS",
      "PAYMENT_DATA",
      "LOANS",
      "INVESTMENTS"
    ],
    "createdAt": "2023-07-12T20:20:17.253Z",
    "isSandbox": false,
    "isOpenFinance": true
  },
  "consentUrl": "https://consenturl.com"
}