/payments/requests/{id}Recuperar
Recupera o recurso de solicitação de pagamento pelo seu id
Parameters
Path Parameters
| Name | Type |
|---|---|
idrequired | string (uuid) |
Responses
Resposta com informações relacionadas a uma solicitação de pagamento
Identificador principal
Valor solicitado. Para pix automático, não será devolvido.
Taxas cobradas pela solicitação de pagamento. Isso inclui tanto as taxas da Pluggy quanto quaisquer taxas específicas do cliente. As taxas são calculadas com base no método de pagamento (PIX ou Boleto) e na configuração de preços do cliente. Para contas de sandbox, as taxas são definidas como 0.
Descrição do pagamento
Ciclo de vida de uma solicitação de pagamento. - `CREATED`: a solicitação foi criada e está aguardando uma intenção de pagamento. - `IN_PROGRESS`: uma intenção de pagamento está sendo processada pela instituição. - `WAITING_PAYER_AUTHORIZATION`: o pagador deve autorizar o pagamento na instituição. - `AUTHORIZED`: apenas para PIX Automático. O consentimento recorrente foi autorizado; pagamentos individuais serão executados sob ele. - `SCHEDULED`: o pagamento está agendado para uma data futura. - `COMPLETED`: o pagamento foi confirmado pela instituição. - `ERROR`: o pagamento falhou (veja `errorDetail`). - `REFUND_IN_PROGRESS`: um reembolso foi solicitado e está sendo processado. - `REFUNDED`: o reembolso foi concluído. - `REFUND_ERROR`: o reembolso falhou. - `EXPIRED`: a solicitação expirou sem ser paga. - `CANCELED`: a solicitação foi cancelada.
Identificador de pagamento do cliente
Data em que a solicitação de pagamento foi criada
Data em que o pedido de pagamento foi atualizado
Redirecionar URLs após o pagamento ser concluído ou encerrado com status de erro
Destinatário do pagamento. A forma depende do `tipo` do destinatário.
Destinatário incorporado dentro de uma solicitação de pagamento. Polimórfico dependendo do tipo de pagamento. - `BANK_ACCOUNT`: um destinatário de conta bancária registrada (veja `PaymentRecipient`). - `PIX_QR_CODE`: destinatário derivado de um código QR PIX anexado à solicitação. - `BOLETO`: destinatário derivado de um boleto anexado à solicitação.
Cliente associado à solicitação de pagamento
Resposta com informações relacionadas a um cliente de pagamento
Conta inteligente que recebe os fundos, quando aplicável
Conta Pluggy Smart (conta de custódia) vinculada a uma solicitação de pagamento. Recebe fundos e permite que o cliente orquestre divisões e retiradas.
URL para iniciar o fluxo de criação de intenção de pagamento para esta solicitação de pagamento
Código QR Pix gerado pelo recebedor do pagamento
Dados do Boleto
Dados automáticos do PIX
Valor fixo da cobrança; se preenchido, representa consentimento para pagamentos de valores fixos, não sujeitos a alteração durante a validade do consentimento. Se enviado, minimumVariableAmount e maximumVariableAmount não podem ser fornecidos.
Valor mínimo permitido por cobrança; se preenchido, representa consentimento para pagamentos de valores variáveis. Se enviado, fixedAmount não pode ser fornecido.
Valor máximo permitido por cobrança; se preenchido, representa consentimento para pagamentos de valores variáveis. Se enviado, fixedAmount não pode ser fornecido.
Representa a data esperada para a primeira ocorrência de um pagamento associado à recorrência.
Data de expiração para a autorização automática de pix
Indica se o cliente receptor tem permissão para fazer tentativas de pagamento, de acordo com as regras estabelecidas no arranjo do Pix.
Definições para o primeiro pagamento. É considerado como o pagamento de inscrição do usuário para o serviço.
Frequência permitida para pagamentos recorrentes de PIX sob um consentimento.
Configuração para tentativas automáticas. Se fornecido, os pagamentos agendados associados a este consentimento serão tentados novamente apenas nos dias especificados na matriz após a data do pagamento original. Isso não se aplica ao primeiro pagamento, apenas para pagamentos agendados.
Configuração para agendamento automático de pagamentos. Quando ativado, o sistema agendará pagamentos de acordo com o intervalo de consentimento e a data de início.
Agende um atributo para gerar um único pagamento em uma data futura específica.
Agende o atributo para gerar pagamentos diários a partir de `startDate`.
Agende o atributo para gerar pagamentos semanais em um dia específico da semana.
Agende o atributo para gerar pagamentos mensais em um dia específico do mês.
Agende o atributo para gerar pagamentos em uma lista explícita de datas.
Detalhes do erro quando a solicitação de pagamento falha
Error code
Error message returned by the institution
Indica se esta solicitação de pagamento está no modo sandbox. Padrão: falso.
Default: false
Example response
{
"id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
"amount": 100.5,
"description": "Transferência",
"status": "CREATED",
"createdAt": "2023-11-06T13:03:45.689Z",
"updatedAt": "2023-11-06T13:03:45.689Z",
"callbackUrls": null,
"paymentUrl": "https://pay.pluggy.ai/05c693bf-c196-47ea-a28c-8251d6bb8a06",
"recipient": null,
"isSandbox": false
}curl -X GET \
'https://api.pluggy.ai/payments/requests/{id}' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY'{
"id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
"amount": 100.5,
"description": "Transferência",
"status": "CREATED",
"createdAt": "2023-11-06T13:03:45.689Z",
"updatedAt": "2023-11-06T13:03:45.689Z",
"callbackUrls": null,
"paymentUrl": "https://pay.pluggy.ai/05c693bf-c196-47ea-a28c-8251d6bb8a06",
"recipient": null,
"isSandbox": false
}