Cancelando uma transação

Sobre cancelamento de transação#

O cancelamento só é possível em transações no estado authorized (autorizadas e aguardando captura). Transações já capturadas não podem ser canceladas — nesse caso, utilize o reembolso.

O cancelamento libera imediatamente a reserva na carteira do cliente, evitando qualquer cobrança posterior.

info

O prazo para cancelar uma transação autorizada é de até 6 dias a partir da data de autorização. Após esse prazo, a transação passa automaticamente para EXPIRED.

Endpoint#

POST https://ecommerce-api.svc.picpay.com/v1/payments/cancel

Exemplo de requisição#

curl --location --request POST 'https://ecommerce-api.svc.picpay.com/v1/payments/cancel' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
  "transaction_id": "57e8b5af-d42b-42a4-9d5e-181aacf1ee9e",
  "reference_id": "61b19b5c-0cd2-4cb9-931a-c797bb8b9222"
}'

Parâmetros do body#

Campo	Tipo	Obrigatório	Descrição
`transaction_id`	`string`	Sim*	Identificador da transação gerado pelo PicPay no momento da cobrança
`reference_id`	`string`	Sim*	Identificador único da transação gerado pelo parceiro

*Ao menos um dos dois identificadores deve ser informado. Quando os dois forem enviados, ambos serão validados.

Exemplo de resposta#

{
  "transaction_id": "57e8b5af-d42b-42a4-9d5e-181aacf1ee9e",
  "reference_id": "61b19b5c-0cd2-4cb9-931a-c797bb8b9222",
  "created_at": "2020-04-16 20:59:58"
}

A transação passa de AUTHORIZED para CANCELLED.

Erros possíveis#

`business_code`	HTTP	Descrição
`TRANSACTION_CANT_BE_CANCELLED`	409	Status não permite cancelamento
`TRANSACTION_NOT_FOUND`	404	Transação não encontrada

Próximos passos#

Reembolsando pagamentos