Para realizar pagamento pix para uma chave externa deve ser utilizado dois endpoint onde primeiro é criado o pagamento e depois aprovado em outro endpoint.

1 - Criar o pagamento

Endpoint:

POST /api/v1/payment

{
  "correlationID": "payment1",
  "destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
  "destinationAliasType": "RANDOM",
  "type": "PIX_KEY",
  "value": 100,
  "comment": "payment comment"
}

Campos

  • correlationID (obrigatório)
    Identificador único do pagamento no seu sistema.

    O que é um Correlation ID?

    Um Correlation ID é um identificador exclusivo associado a uma transação ou solicitação específica que percorre todo o ciclo de vida da operação, desde a entrada até a saída do sistema. Isso é essencial para rastrear e correlacionar eventos e logs relacionados a uma determinada transação, facilitando a depuração e o monitoramento de sistemas complexos.

  • destinationAlias (obrigatório)
    Chave PIX de destino.

  • destinationAliasType (obrigatório)
    Tipo da chave PIX

  • type (obrigatório)
    Tipo do pagamento.

  • value (obrigatório)
    Valor do pagamento em centavos.

  • comment (opcional)
    Descrição que será enviada junto ao pagamento.

  • metadata (opcional)
    Objeto para informações adicionais (máx. 30 chaves).

  • pixKeyEndToEndId (opcional)
    Identificador end-to-end da chave PIX para rastreamento.

Este request apenas cria a solicitação de pagamento. Para que o PIX seja efetivado, é necessário realizar a aprovação da solicitação em uma etapa posterior.

Link Documentação: https://developers.woovi.com/api#tag/payment-request-access/POST/api/v1/payment

2 - Aprovar solicitação de pagamento PIX

Este endpoint é responsável por aprovar uma solicitação de pagamento previamente criada, efetivando o pagamento via PIX.

Endpoint:

POST /api/v1/payment/approve

Body:

{
  "correlationID": "payment1"
}

Campos

  • correlationID (obrigatório)
    Identificador do pagamento retornado na criação da solicitação.

Após utilizar os dois endpoints a transação esta finalizada.

Link documentação: https://developers.woovi.com/api#tag/payment-request-access/POST/api/v1/payment/approve

OBS: Para utilizar a função de pix externo é necessário habilitar a permissão na sua conta para que os pagamentos externos sejam autorizados. Veja em: https://ajuda.woovi.com/hc/duvidas-frequentes/articles/como-ativar-o-pix-out-pagamento-externo