Estornar cobrança

Esse endpoint permite estornar uma cobrança de Pix através da transação. A devolução é solicitada ao banco emissor no momento da chamada.

Ao solicitar o estorno, a transação parte do status 3 (Autorizado) e segue um de dois caminhos, conforme a resposta do banco do pagador:

%%{init: {"flowchart": {"curve": "linear"}, "themeVariables": {"lineColor": "#7B8A97", "fontFamily": "Trebuchet MS, Verdana, Arial"}}}%%
flowchart TD
    INÍCIO((INÍCIO)) --> A[AUTORIZADO]

    A -->|banco confirma a devolução na hora| E[ESTORNADO]
    A -->|banco não confirma de imediato| D["EM DEVOLUÇÃO"]

    D -->|devolução confirmada| E
    D -->|devolução não realizada| A

    E --> FIM((FIM))

    classDef autorizado fill:#16A085,stroke:#16A085,color:#FFFFFF,font-weight:bold
    classDef emDevolucao fill:#BCC7D1,stroke:#BCC7D1,color:#37474F,font-weight:bold
    classDef estornado fill:#F5B942,stroke:#F5B942,color:#FFFFFF,font-weight:bold
    classDef inicio fill:#FFFFFF,stroke:#B0BEC5,color:#78909C,font-weight:bold
    classDef fim fill:#3D4F5D,stroke:#3D4F5D,color:#FFFFFF,font-weight:bold

    class A autorizado
    class D emDevolucao
    class E estornado
    class COMEÇO inicio
    class FIM fim
    linkStyle default stroke:#7B8A97,stroke-width:2px
  • Estorno concluído na hora: o banco confirma a devolução na própria requisição. A transação passa direto para 6 (Estornado) e a resposta retorna IsCancelled: true.
  • Estorno em processamento: o banco não confirma de imediato. A transação passa para 19 (Em Devolução), o valor fica reservado na conta do recebedor e a resposta retorna IsCancelled: false. A partir daí o Safe2Pay acompanha a devolução junto ao banco e conclui automaticamente, em geral no decorrer do mesmo dia:
    • devolução confirmada: a transação muda para 6 (Estornado);
    • devolução não realizada pelo banco: o valor é liberado de volta e a transação retorna para 3 (Autorizado).

Nenhuma ação é necessária enquanto a transação estiver em 19 (Em Devolução). A operação é idempotente: repetir a chamada de estorno nesse período retorna novamente a resposta de estorno em processamento, sem duplicar o pedido de devolução.

Cada mudança de status dispara o webhook transacional e é refletida na consulta da transação. Prepare sua integração para receber o status 19 (Em Devolução) e os desfechos 6 (Estornado) ou 3 (Autorizado).

Path Params
integer
required

Código identificador da transação a ser estornada.

Headers
string
Defaults to X-API-KEY
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json