Reembolsando pagamentos

Solicitando um reembolso de uma cobrança à carteira do usuário#

A solicitação de reembolso deverá ser gerada com o transaction_id ou reference_id através do endpoint v1/payments/refund, indicando o valor a ser reembolsado no corpo da requisição. No exemplo abaixo, estamos solicitando o reembolso de R$ 3,00 na carteira do usuário.

Informação

O campo transaction_id é gerado no momento da criação do pagamento.

curl --location 'https://api.picpay.com/v1/payments/refund' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'x-Idempotency-Key: {{idempotency_key}}' \
--header 'Content-Type: application/json' \
--data '{
  "value": 3,
  "transaction_id": "daef8a44-b408-4df1-b726-c579723f1116",
  "reference_id": "f997bbef-8e17-4e59-b1a9-de1fe1dedd51"
}'

Caso a solicitação seja processada com sucesso, retornará um código HTTP 200.

Como será feito o reembolso?#

O saldo será retornado ao mesmo lugar da origem dos fundos, ou seja:

Caso a transação tiver sido feita por cartão de crédito, será estornada no cartão;
Caso a transação tiver sido feita no saldo, o saldo retornará a carteira do cliente;
Caso a transação seja mista (Saldo + Cartão), parte retornara como saldo na carteira e parte será estornada no cartão;

Mensagens de erro#

Não informamos os códigos de erro no processo de estorno. Apenas informamos se a transação foi estornada ou não. Exemplo:

{
    "message": "Transaction could not be refund"
}