POST/payments/intents

Criar

Cria o recurso de intenção de pagamento

Para criar uma Payment Intent, será necessário gerar primeiro um PaymentRequest e enviar o identificador como paymentRequestId.

A PaymentIntent identifica a intenção de um usuário de cumprir uma solicitação de pagamento e enviará duas coisas principais.

O Connector (connectorId): identifica a instituição através da qual o usuário enviará o dinheiro. Isso pode ser recuperado do endpoint /connectors filtrando por supportsPaymentInitiation = true.
Identificação do Usuário (parameters): Para a iniciação de pagamento, uma instituição requer a identificação do usuário na forma de CPF e, no caso de Empresas, enviar o CNPJ também.

{
  "paymentRequestId": "c2a6b7d9-3349-435d-8341-44021449ebbc",
  "connectorId": 603,
  "parameters": {
    "cpf": "11111111111"
  }
}

Request Body

required

object

Request with information to create a payment intent

paymentRequestIdstring

Identificador principal da solicitação de pagamento associada à intenção de pagamento

parametersobject

Credentials neccesary to create a payment intent

cpfrequiredstring

CPF do pagador

cnpjstring

CNPJ do pagador

namestring

Nome do pagador. Somente necessário para solicitações de pagamento pix automáticas.

connectorIdnumber

Identificador principal do conector associado à intenção de pagamento

paymentMethodstring

O método de pagamento pode ser PIS (Payment Initiation) ou PIX (fluxo de QR do PIX).

PIS

isDynamicPixboolean

Apenas para o método de pagamento PIX. Se verdadeiro, o código QR PIX gerado é dinâmico e de uso único. Isso requer que o customerId esteja presente, e o cliente deve ter CPF/CNPJ.

Example

json

{}

Responses

200Criar uma intenção de pagamento.

object

Request with information related to a payment intent

idrequiredstring

Identificador principal

statusrequiredstring

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). - `PAYMENT_TIMEOUT`: the authorization attempt exceeded its timeout. Regular payment attempts time out after 30 minutes; Automatic PIX attempts time out after 60 minutes. The Payment Request returns to `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

Response with information related to a payment request

connectorobject

Conector associado à intenção de pagamento

All of:

part 1object

Connector object

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

Payment Intent PIX data

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

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.

option 2null | null

errorDetailobject

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

All of:

part 1object

Details about an error that occurred with the payment intent

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"
  },
  "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 POST \
  'https://api.pluggy.ai/payments/intents' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{}'

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"
  },
  "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"
}