Skip to main content

Como buscar todos os reembolsos de uma cobrança usando a API?

Para buscar todos os reembolsos de uma cobrança usando a API, você deverá fazer uma chamada GET para o endpoint /api/v1/charge/{correlationID}/refund usando correlationID da cobrança.

Você pode acessar aqui a documentação referente a esse endpoint.

Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, retornaremos os reembolsos da cobrança.

Retornarmeros a seguinte resposta de exemplo:

{
  "refunds": [
    {
      "status": "IN_PROCESSING"
      "value": 100
      "correlationID": "aafee9f5-94b3-4e3d-ab6a-416d0a1218cb"
      "endToEndId": "E23114447202304181826HJNwY577YDX"
      "time": "2023-03-02T17:28:51.882Z"
    },
    {
      "status": "CONFIRMED"
      "value": 40
      "correlationID": "589a378e-ab45-4f30-bd4d-4496c60f88cf"
      "endToEndId": "E23114447202304181057pOhPMsp2pJZ"
      "time": "2021-03-05T14:49:02.922Z",
      "comment": "Comentário do reembolso"
    }
  ]
}

Exemplos em código​

 curl --request GET \
     --url https://api.openpix.com.br/api/v1/charge/{correlationID}/refund \
     --header 'Authorization: AUTHORIZATION'