--- title: "Retrieve" method: GET path: "/payments/intents/{id}" tags: ["Payment Intent"] --- # Retrieve `GET /payments/intents/{id}` Recovers the payment intent resource by its id ## Path parameters - `id` string, uuid, required ## Response `200` Retrieve a payment intent. - PaymentIntent — Request with information related to a payment intent - `id` string, required — Primary identifier - `status` 'STARTED' | 'ENQUEUED' | 'CONSENT_AWAITING_AUTHORIZATION' | 'CONSENT_AUTHORIZED' | 'CONSENT_REJECTED' | 'PAYMENT_PENDING' | 'PAYMENT_PARTIALLY_ACCEPTED' | 'PAYMENT_SETTLEMENT_PROCESSING' | 'PAYMENT_SETTLEMENT_DEBTOR_ACCOUNT' | 'PAYMENT_COMPLETED' | 'PAYMENT_REJECTED' | 'REJECTED' | 'ERROR' | 'CANCELED' | 'REVOKED' | 'CONSUMED', required — Lifecycle of a payment intent. The flow goes from consent collection (CONSENT_*) to payment execution (PAYMENT_*). **Consent phase** - `STARTED`: the consent process started at Pluggy. - `ENQUEUED`: the payment is enqueued waiting for the consent flow to be initiated. - `CONSENT_AWAITING_AUTHORIZATION`: the payer must complete the authorization at the institution (see `consentUrl`). - `CONSENT_AUTHORIZED`: the consent was granted by the payer. - `CONSENT_REJECTED`: the consent was rejected by the payer or the institution. **Payment phase** - `PAYMENT_PENDING`: the payment was submitted to the institution and is waiting confirmation. - `PAYMENT_PARTIALLY_ACCEPTED`: the payment was accepted but still needs an additional authorization (e.g. multi-signature accounts). - `PAYMENT_SETTLEMENT_PROCESSING`: the settlement is being processed. - `PAYMENT_SETTLEMENT_DEBTOR_ACCOUNT`: the funds were debited from the payer account; awaiting clearing. - `PAYMENT_COMPLETED`: the payment was confirmed by the institution. - `PAYMENT_REJECTED`: the payment was rejected after consent was authorized. **Terminal / other** - `REJECTED`: generic rejected status (institution-specific reason in `errorDetail`). - `ERROR`: an unexpected error occurred during the flow. - `CANCELED`: the intent was canceled. - `REVOKED`: the consent was revoked after authorization (recurring payments only). - `CONSUMED`: the consent was fully consumed (recurring payments reached their end). - `createdAt` string, date-time, required — Date when the payment intent was created - `updatedAt` string, date-time, required — Date when the payment intent was updated - `paymentRequest` PaymentRequest — Response with information related to a payment request - `id` string, required — Primary identifier - `amount` number — Requested amount. For automatic pix it won't be returned - `fees` number — Fees charged for the payment request. This includes both Pluggy's fees and any customer-specific fees. Fees are calculated based on the payment method (PIX or Boleto) and the client's pricing configuration. For sandbox accounts, fees are set to 0. - `description` string — Payment description - `status` 'CREATED' | 'IN_PROGRESS' | 'WAITING_PAYER_AUTHORIZATION' | 'AUTHORIZED' | 'SCHEDULED' | 'COMPLETED' | 'ERROR' | 'REFUND_IN_PROGRESS' | 'REFUNDED' | 'REFUND_ERROR' | 'EXPIRED' | 'CANCELED', required — Lifecycle of a payment request. - `CREATED`: the request was created and is waiting for a payment intent. - `IN_PROGRESS`: a payment intent is being processed by the institution. - `WAITING_PAYER_AUTHORIZATION`: the payer must authorize the payment at the institution. - `AUTHORIZED`: only for Automatic PIX. The recurring consent was authorized; individual payments will be executed under it. - `SCHEDULED`: the payment is scheduled for a future date. - `COMPLETED`: the payment was confirmed by the institution. - `ERROR`: the payment failed (see `errorDetail`). - `REFUND_IN_PROGRESS`: a refund was requested and is being processed. - `REFUNDED`: the refund was completed. - `REFUND_ERROR`: the refund failed. - `EXPIRED`: the request expired without being paid. - `CANCELED`: the request was canceled. - `clientPaymentId` string — Client payment identifier - `createdAt` string, date-time, required — Date when the payment request was created - `updatedAt` string, date-time, required — Date when the payment request was updated - `callbackUrls` PaymentRequestCallbackUrls — Redirect urls after the payment was completed or ended in error status - `success` string — Url to be redirected after the payment was completed - `pending` string — Url to be redirected when the payment is pending (for example, when it has status WAITING_PAYER_AUTHORIZATION - `error` string — Url to be redirected after the payment ended in error status - `recipient` union — Recipient embedded inside a payment request. Polymorphic depending on the kind of payment. - `BANK_ACCOUNT`: a registered bank-account recipient (see `PaymentRecipient`). - `PIX_QR_CODE`: recipient derived from a PIX QR code attached to the request. - `BOLETO`: recipient derived from a boleto attached to the request. - PaymentRecipient — Bank-account payment recipient. Returned by `/payments/recipients` endpoints and embedded inside payment requests when the request targets a registered recipient. - `type` 'BANK_ACCOUNT', required — Recipient discriminator. Always `BANK_ACCOUNT` for this schema. - `id` string, required — Primary identifier - `taxNumber` string, required — Account owner tax number. Can be CPF or CNPJ (only numbers). - `name` string, required — Account owner name. - `paymentInstitution` PaymentInstitution, required — Response with information related to a payment institution - `id` string, required — Primary identifier - `name` string, required — Payment institution name - `tradeName` string, required — Payment institution trade name - `ispb` string, required — Payment institution ISPB - `compe` string — Payment institution COMPE - `createdAt` string, date-time, required — Date when the payment institution was created - `updatedAt` string, date-time, required — Date when the payment institution was updated - `isDefault` boolean, required — Indicates if the recipient is the default one - `account` PaymentRecipientAccount, required — Payment receiver bank account information - `branch` string, required — Receiver bank account branch (agency) - `number` string, required — Receiver bank account number - `type` string, required — Receiver bank account type, could be: 'CHECKING_ACCOUNT', 'SAVINGS_ACCOUNT' or 'GUARANTEED_ACCOUNT' - `pixKey` string — Pix key associated with the payment recipient - `createdAt` string, date-time, required — Date when the payment recipient was created - `updatedAt` string, date-time, required — Date when the payment recipient was last updated - PixQrPaymentRecipient — Payment recipient inferred from a PIX QR code (only the merchant name is exposed). - `type` 'PIX_QR_CODE', required - `name` string — Merchant name decoded from the PIX QR code - BoletoPaymentRecipient — Payment recipient inferred from a boleto. - `type` 'BOLETO', required - `name` string — Recipient name from the boleto - `taxNumber` string — Recipient CPF or CNPJ from the boleto - `customer` PaymentCustomer — Response with information related to a payment customer - `id` string, required — Primary identifier - `type` 'INDIVIDUAL' | 'BUSINESS', required — Customer type. - `INDIVIDUAL`: identified by `cpf`. - `BUSINESS`: identified by `cnpj`. - `name` string, required — Customer name - `email` string — Customer email - `cpf` string — Customer CPF - `cnpj` string — Customer CNPJ, if type is `BUSINESS` - `connector` Connector — Connector object - `id` number, required — Primary identifier - `name` string — Name of the institution - `institutionUrl` string — Homepage of the institution - `imageUrl` string — Image of the logo hosted by Pluggy - `primaryColor` string — Primary color - `type` string — Type of institution - `country` string — Country located - `credentials` ConnectorCredential[] — Parameters required to start the connection - `name` string, required — Name of the key - `label` string, required — Label for input - `type` 'text' | 'password' | 'number' | 'image' | 'select', required — Type of credential required - `assistiveText` string — Text to help the user when completing the input - `data` string — Used to return base64 images - `placeholder` string — Placeholder text for the input - `validation` string — Regex validation for the user's input - `validationMessage` string — Validation message when input doesn't match the regex - `mfa` boolean — Credential is an MFA parameter and must be refreshed on each execution - `options` CredentialSelectOption[] — List of possible values for the input - `value` string, required — Value for the option - `label` string, required — Label for the option - `hasMFA` boolean — Does the connector require an MFA to execute? - `products` string[] — Products supported by the connector - `oauth` boolean — If 'true', the connector requires an Oauth flow to execute - `oauthUrl` string — URL to perform Oauth flow if needed - `resetPasswordUrl` string — URL to the financial institution to reset the password - `health` ConnectorHealth — Connector health status - `status` string — 'ONLINE' | 'OFFLINE' | 'UNSTABLE' - `stage` string - `details` object — Statistics about your recent connections on the connector and recent connection rate (percentage of healthy connections). This field is only present if you include the parameter healthDetails=true. This will be null if there was an error obtaining health details. - `connectionRateLast6Hours` number — A number from 0 to 100: the percentage of executions that succesfully connect to the institution: status of CONNECTION_ERROR,ERROR,SITE_NOT_AVAILABLE decrease the percentage. Any other status (like SUCCESS/LOGIN_ERROR) increase the percentage. The value will be null if there were no connections - `connectionsLast6Hours` number — Amount of your connections for this connector during the last 6 hours. 0 if there were no connections - `isOpenFinance` boolean — Indicates if the connector uses the regulated Open Finance APIs - `supportsPaymentInitiation` boolean — Indicates if the connector supports the payment initiation API - `supportsScheduledPayments` boolean — Indicates if the connector supports scheduled payments - `supportsSmartTransfers` boolean — Indicates if the connector supports smart transfers - `supportsBoletoManagement` boolean — Indicates if the connector supports boleto management - `supportsAutomaticPix` boolean — Indicates if the connector supports automatic Pix - `createdAt` string, date-time — Date of creation - `updatedAt` string, date-time — Date of last modification - `createdAt` string, date-time, required — Date when the customer was created - `updatedAt` string, date-time, required — Date when the customer was last updated - `smartAccount` SmartAccount — Pluggy Smart Account (escrow account) attached to a payment request. Receives funds and lets the client orchestrate splits and withdrawals. - `id` string, uuid, required - `agency` string, required — Bank agency of the smart account - `number` string, required — Account number - `verifyingDigit` string, required — Account verifying digit - `type` 'CHECKING_ACCOUNT', required — Smart accounts are always checking accounts - `isSandbox` boolean, required - `owner` string — Legal name of the smart account holder. Only returned in detailed views. - `pixKey` string — PIX key associated with the smart account - `paymentUrl` string, required — URL to begin the payment intent creation flow for this payment request - `pixQrCode` string — Pix QR code generated by the payment receiver - `boleto` Boleto — Boleto data - `digitableLine` string, required — Boleto digitable line - `barcode` string, required — Boleto barcode - `payer` BoletoPayer, required — Boleto payer information - `taxNumber` string, required — Payer CPF or CNPJ - `name` string, required — Payer name - `recipient` BoletoRecipient, required — Boleto recipient information - `taxNumber` string, required — Recipient CPF or CNPJ - `name` string, required — Recipient name - `date` string, date-time — Boleto issue date - `dueDate` string, date-time, required — Boleto due date - `expirationDate` string, date-time — After this date, the boleto cannot be paid - `baseAmount` number, required — Boleto original amount, without interests, penalties and discounts - `penaltyAmount` number, required — Boleto penalty amount. If there is no penalty, it will be returned as zero - `interestAmount` number — Boleto interest amount. If there is no interest, it will be returned as zero - `discountAmount` number, required — Boleto discount amount. If there is no discounts, it will be returned as zero - `totalAmount` number, required — Boleto final amount. It is equal to the base amount plus penalties and interests, minus discounts - `updatedAt` string, date-time — Date when the lastest information of this boleto has been retrieved - `automaticPix` AutomaticPix — Automatic PIX data - `fixedAmount` number — Fixed charge amount; if filled in, it represents consent for payments of fixed amounts, not subject to change during the validity of the consent. If it's sent, minimumVariableAmount and maximumVariableAmount cannot be provided. - `minimumVariableAmount` number — Minimum amount allowed per charge; if filled in, it represents consent for payments of variable amounts. If it's sent, fixedAmount cannot be provided. - `maximumVariableAmount` number — Maximum amount allowed per charge; if filled in, it represents consent for payments of variable amounts. If it's sent, fixedAmount cannot be provided. - `startDate` string, date-time, required — Represents the expected date for the first occurrence of a payment associated with the recurrence. - `expiresAt` string, date-time — Expiration date for the automatic pix authorization - `isRetryAccepted` boolean — Indicates whether the receiving customer is allowed to make payment attempts, according to the rules established in the Pix arrangement. - `firstPayment` AutomaticPixFirstPayment — Definitions for the first payment. It is considered as the user's enrollment payment for the service. - `date` string, date-time — Defines the target settlement date of the first payment. If not provided, it will be settled immediately. Date format must be YYYY-MM-DD (for example: 2025-06-16) - `description` string — Description for the first payment. If not provided, the description will be the same as the description of the payment request - `amount` number, required — Amount for the first payment. - `interval` 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMESTER' | 'YEARLY', required — Permitted frequency for recurring PIX payments under a consent. - `automaticRetriesConfiguration` AutomaticPixRetriesConfiguration — “Configuration for automatic retries. If provided, the scheduled payments associated with this consent will only be retried on the days specified in the array after the original payment date. This does not apply to the first payment, only for scheduled payments. - `retryDays` integer[], required - `schedulerConfiguration` AutomaticPixSchedulerConfiguration — Configuration for automatic scheduling of payments. When enabled, the system will schedule payments according to the consent interval and start date. - `enabled` boolean, required — When true, payments are automatically scheduled by the system. - `description` string — Optional description for the scheduled payment. Overrides the payment request description when set. - `valueForVariableAmount` number — Required when the consent has variable amounts (minimumVariableAmount/maximumVariableAmount). Default amount to use when scheduling the payment. - `schedule` union - SINGLE — Schedule attribute to generate a single payment on a specific future date. - `type` 'SINGLE', required — Schedule discriminator. Always `SINGLE` for this variant. - `date` string, date, required — Settlement date for the payment (YYYY-MM-DD). - DAILY — Schedule attribute to generate daily payments starting from `startDate`. - `type` 'DAILY', required — Schedule discriminator. Always `DAILY` for this variant. - `startDate` string, date, required — The start date of the validity of the scheduled payment authorization. - `occurrences` number, required — Under the specified schedule frequency, how many payments will be scheduled to occur. - WEEKLY — Schedule attribute to generate weekly payments on a specific day of the week. - `type` 'WEEKLY', required — Schedule discriminator. Always `WEEKLY` for this variant. - `startDate` string, date, required — The start date of the validity of the scheduled payment authorization. - `dayOfWeek` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY', required — Day of the week on which each payment will occur. For instance, if set to `MONDAY`, the first payment will occur on the first Monday after `startDate` (or the same day, if it is already Monday), and every Monday after that. - `occurrences` number, required — Under the specified schedule frequency, how many payments will be scheduled to occur. - MONTHLY — Schedule attribute to generate monthly payments on a specific day of the month. - `type` 'MONTHLY', required — Schedule discriminator. Always `MONTHLY` for this variant. - `startDate` string, date, required — The start date of the validity of the scheduled payment authorization. - `dayOfMonth` number, required — Day of the month on which each payment will occur. For example, if `10`, the first payment will occur on the next 10th day of the month after `startDate` (or the same day if it is already the 10th), and every 10th day after that. - `occurrences` number, required — Under the specified schedule frequency, how many payments will be scheduled to occur. - CUSTOM — Schedule attribute to generate payments on an explicit list of dates. - `type` 'CUSTOM', required — Schedule discriminator. Always `CUSTOM` for this variant. - `dates` string[], required — Explicit list of dates (YYYY-MM-DD) on which payments will be settled. - `additionalInformation` string — Additional information about the custom schedule - `errorDetail` object — Error details when payment request fails - `code` string — Error code - `providerMessage` string — Error message returned by the institution - `isSandbox` boolean — Indicates if this payment request is in sandbox mode. Default: false. - `connector` Connector — Connector object - `id` number, required — Primary identifier - `name` string — Name of the institution - `institutionUrl` string — Homepage of the institution - `imageUrl` string — Image of the logo hosted by Pluggy - `primaryColor` string — Primary color - `type` string — Type of institution - `country` string — Country located - `credentials` ConnectorCredential[] — Parameters required to start the connection - `name` string, required — Name of the key - `label` string, required — Label for input - `type` 'text' | 'password' | 'number' | 'image' | 'select', required — Type of credential required - `assistiveText` string — Text to help the user when completing the input - `data` string — Used to return base64 images - `placeholder` string — Placeholder text for the input - `validation` string — Regex validation for the user's input - `validationMessage` string — Validation message when input doesn't match the regex - `mfa` boolean — Credential is an MFA parameter and must be refreshed on each execution - `options` CredentialSelectOption[] — List of possible values for the input - `value` string, required — Value for the option - `label` string, required — Label for the option - `hasMFA` boolean — Does the connector require an MFA to execute? - `products` string[] — Products supported by the connector - `oauth` boolean — If 'true', the connector requires an Oauth flow to execute - `oauthUrl` string — URL to perform Oauth flow if needed - `resetPasswordUrl` string — URL to the financial institution to reset the password - `health` ConnectorHealth — Connector health status - `status` string — 'ONLINE' | 'OFFLINE' | 'UNSTABLE' - `stage` string - `details` object — Statistics about your recent connections on the connector and recent connection rate (percentage of healthy connections). This field is only present if you include the parameter healthDetails=true. This will be null if there was an error obtaining health details. - `connectionRateLast6Hours` number — A number from 0 to 100: the percentage of executions that succesfully connect to the institution: status of CONNECTION_ERROR,ERROR,SITE_NOT_AVAILABLE decrease the percentage. Any other status (like SUCCESS/LOGIN_ERROR) increase the percentage. The value will be null if there were no connections - `connectionsLast6Hours` number — Amount of your connections for this connector during the last 6 hours. 0 if there were no connections - `isOpenFinance` boolean — Indicates if the connector uses the regulated Open Finance APIs - `supportsPaymentInitiation` boolean — Indicates if the connector supports the payment initiation API - `supportsScheduledPayments` boolean — Indicates if the connector supports scheduled payments - `supportsSmartTransfers` boolean — Indicates if the connector supports smart transfers - `supportsBoletoManagement` boolean — Indicates if the connector supports boleto management - `supportsAutomaticPix` boolean — Indicates if the connector supports automatic Pix - `createdAt` string, date-time — Date of creation - `updatedAt` string, date-time — Date of last modification - `consentUrl` string — Url to authorize the payment intent - `referenceId` string — Pix id related to the payment intent - `paymentMethod` 'PIS' | 'PIX' — Payment method can be PIS (Payment Initiation) or PIX - `pixData` PixData — Payment Intent PIX data - `value` string, required — PIX QR raw value - `qr` string, required — PIX QR image in base64 format - `debtor` Debtor — Information about the payer's account, as returned by the institution after the payment is completed. Only populated for `PAYMENT_COMPLETED` payment intents on connectors that expose this data. - `name` string, nullable — Holder name - `taxNumber` string, nullable — Obfuscated CPF/CNPJ of the payer - `bankAccount` object - `agency` string, nullable — Branch number - `account` string, nullable — Account number - `name` string, nullable — Bank name - `errorDetail` PaymentIntentErrorDetail — Details about an error that occurred with the payment intent - `code` 'TEMPO_EXPIRADO_AUTORIZACAO' | 'CONNECTION_ERROR' | 'VALOR_ACIMA_LIMITE' | 'FALHA_INFRAESTRUTURA_DETENTORA' | 'FALHA_INFRAESTRUTURA_DETENTORA_CALLBACK_HYBRID_FLOW' | 'SALDO_INSUFICIENTE' | 'CONTAS_ORIGEM_DESTINO_IGUAIS' | 'EXPIRED_PAYMENT_INITIATION' | 'DATA_PAGAMENTO_INVALIDA' | 'CONSENTIMENTO_PENDENTE_AUTORIZACAO' | 'TEMPO_EXPIRADO_CONSUMO' | 'PAYMENT_INTENT_INVALID_CPF' | 'PAYMENT_INTENT_INVALID_CNPJ' | 'FALHA_AGENDAMENTO_PAGAMENTOS' | 'PAGAMENTO_DIVERGENTE_CONSENTIMENTO' | 'CONTA_NAO_PERMITE_PAGAMENTO' | 'REJEITADO_USUARIO' | 'TIMEOUT_CONSENTIMENTO' | 'PAGAMENTO_RECUSADO_SPI' | 'REVOGADO_RECEBEDOR' | 'NAO_INFORMADO' | 'AUTENTICACAO_DIVERGENTE' | 'TITULARIDADE_INCONSISTENTE' | 'PAGAMENTO_RECUSADO_DETENTORA', required — Error codes expected during payment intent processing: - TEMPO_EXPIRADO_AUTORIZACAO: Consent expired. - CONNECTION_ERROR: Connection error with the institution. - VALOR_ACIMA_LIMITE: Amount exceeds the limit established by the institution or arrangement to allow the client to perform transactions. - FALHA_INFRAESTRUTURA_DETENTORA: Indicates a failure in the infrastructure of the institution holding the information or resources. - FALHA_INFRAESTRUTURA_DETENTORA_CALLBACK_HYBRID_FLOW: Infrastructure failure in the callback hybrid flow. - SALDO_INSUFICIENTE: The selected account does not have sufficient balance to make the payment. - CONTAS_ORIGEM_DESTINO_IGUAIS: Payment failure due to source and destination accounts being the same. - EXPIRED_PAYMENT_INITIATION: Payment initiation expired. - DATA_PAGAMENTO_INVALIDA: Invalid payment date. The scheduled payment end date must be at most 2 years from the start date. - CONSENTIMENTO_PENDENTE_AUTORIZACAO: Consent pending authorization. - TEMPO_EXPIRADO_CONSUMO: Consent expired. - PAYMENT_INTENT_INVALID_CPF: Invalid CPF. - PAYMENT_INTENT_INVALID_CNPJ: Invalid CNPJ. - FALHA_AGENDAMENTO_PAGAMENTOS: Failed to schedule payments. - PAGAMENTO_DIVERGENTE_CONSENTIMENTO: Payment data differs from consent data. - CONTA_NAO_PERMITE_PAGAMENTO: Account does not allow payments. - REJEITADO_USUARIO: Consent canceled by the user. - TIMEOUT_CONSENTIMENTO: Consent timeout. - PAGAMENTO_RECUSADO_SPI: Payment refused by the Instant Payments System (SPI). - REVOGADO_RECEBEDOR: Consent canceled by the receiver. - NAO_INFORMADO: Not reported/identified by the account-holding institution. - AUTENTICACAO_DIVERGENTE: Invalid consent. - TITULARIDADE_INCONSISTENTE: Account currently not associated with the CPF/CNPJ of the long-term consent. - PAGAMENTO_RECUSADO_DETENTORA: Payment refused by the account-holding institution. - `providerCode` string, required — Provider error code - `providerTitle` string, required — Provider error title - `providerDetail` string, required — Provider detailed error description ## Other responses - `404` — Payment Intent not found --- [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)