POST/smart-transfers/payments

Criar pagamento

Cria o recurso de pagamento de transferências inteligentes

Request Body

required

object

Create smart transfer payment request data

preauthorizationIdrequiredstring

Identificador principal da pré-autorização

recipientIdrequiredstring

Identificador principal do destinatário do pagamento

amountrequirednumber

Valor do pagamento

descriptionstring

Descrição do pagamento

clientPaymentIdstring

Identificador de pagamento do cliente

Responses

200Crie um Pagamento de Transferência Inteligente.

object

Smart transfer payment

idrequiredstring

Identificador primário de pagamento

preauthorizationIdrequiredstring

Identificador primário de pagamento

statusrequiredstring

Lifecycle of a Smart Transfer payment. Narrower than `PaymentIntentStatus`: Smart Transfer payments operate under an already-authorized preauthorization, so consent-collection statuses (`STARTED`, `ENQUEUED`, `CONSENT_AWAITING_AUTHORIZATION`) and consent-revocation statuses (`REJECTED`, `REVOKED`, `CONSUMED`) do not apply. - `CONSENT_AUTHORIZED`: the payment was accepted under the preauthorization and is ready to be processed. - `CONSENT_REJECTED`: the preauthorization was rejected at execution time. - `PAYMENT_PENDING`: the payment was submitted to the institution and is awaiting confirmation. - `PAYMENT_PARTIALLY_ACCEPTED`: the payment was accepted but still needs an additional authorization. - `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. - `ERROR`: an unexpected error occurred during the flow. - `CANCELED`: the payment was canceled.

CONSENT_AUTHORIZEDCONSENT_REJECTEDPAYMENT_PENDINGPAYMENT_PARTIALLY_ACCEPTEDPAYMENT_SETTLEMENT_PROCESSINGPAYMENT_SETTLEMENT_DEBTOR_ACCOUNTPAYMENT_COMPLETEDPAYMENT_REJECTEDERRORCANCELED

amountrequirednumber

Valor do pagamento

descriptionstring

Descrição do pagamento

recipientobject | null

Destinatário da transferência. Pode ser nulo até que o pagamento seja associado a um.

Any of:

option 1object

Bank-account payment recipient. Returned by `/payments/recipients` endpoints and embedded inside payment requests when the request targets a registered recipient.

option 2null | null

clientPaymentIdstring

Identificador de pagamento do cliente

createdAtrequiredstring (date-time)

Data em que o pagamento foi criado

updatedAtrequiredstring (date-time)

Data em que o pagamento foi atualizado

errorDetailobject

Detalhe do erro

codestring

Error code. - INFRASTRUCTURE_FAILURE: Indicates a failure in the infrastructure of the institution holding the information or resources. - PAYMENT_DIFFERENT_FROM_CONSENT: Payment data differs from consent data. - UNKNOWN_ERROR: Unknown error. - INVALID_PAYMENT_DETAIL: The payment detail is invalid. - PAYMENT_REJECTED_BY_HOLDER: The payment was rejected by the account holder. - PAYMENT_REJECTED_BY_SPI: The payment was rejected by the SPI.

INFRASTRUCTURE_FAILUREPAYMENT_DIFFERENT_FROM_CONSENTUNKNOWN_ERRORINVALID_PAYMENT_DETAILPAYMENT_REJECTED_BY_HOLDERPAYMENT_REJECTED_BY_SPI

descriptionstring

Error description

detailstring

Error detail

Example response

json

{
  "id": "string",
  "preauthorizationId": "string",
  "status": "CONSENT_AUTHORIZED",
  "amount": 0,
  "description": "string",
  "recipient": {
    "type": "BANK_ACCOUNT",
    "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
    "name": "Conta empresa",
    "taxNumber": "12345678900",
    "paymentInstitution": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Banco J. Safra S.A.",
      "ispb": "03017677",
      "tradeName": "Banco Safra",
      "compe": "074",
      "createdAt": "2020-04-21T15:00:00.000Z",
      "updatedAt": "2020-04-21T15:00:00.000Z"
    },
    "account": {
      "branch": "0001",
      "number": "123456",
      "type": "CHECKING_ACCOUNT"
    },
    "isDefault": false,
    "pixKey": null,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  },
  "clientPaymentId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "errorDetail": {
    "code": "INFRASTRUCTURE_FAILURE",
    "description": "string",
    "detail": "string"
  }
}

curl -X POST \
  'https://api.pluggy.ai/smart-transfers/payments' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{}'

Resposta de exemplo

{
  "id": "string",
  "preauthorizationId": "string",
  "status": "CONSENT_AUTHORIZED",
  "amount": 0,
  "description": "string",
  "recipient": {
    "type": "BANK_ACCOUNT",
    "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
    "name": "Conta empresa",
    "taxNumber": "12345678900",
    "paymentInstitution": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Banco J. Safra S.A.",
      "ispb": "03017677",
      "tradeName": "Banco Safra",
      "compe": "074",
      "createdAt": "2020-04-21T15:00:00.000Z",
      "updatedAt": "2020-04-21T15:00:00.000Z"
    },
    "account": {
      "branch": "0001",
      "number": "123456",
      "type": "CHECKING_ACCOUNT"
    },
    "isDefault": false,
    "pixKey": null,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  },
  "clientPaymentId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "errorDetail": {
    "code": "INFRASTRUCTURE_FAILURE",
    "description": "string",
    "detail": "string"
  }
}