Estornar

DELETE

api

pix

{idFaturaPag}

Estornar

curl --request DELETE \
  --url https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "sucesso": true,
  "data": {
    "retTexto": "Estorno solicitado com sucesso"
  }
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

Este endpoint é o estorno integral. Devolve todo o valor de uma cobrança PIX já paga. Use o mesmo idFaturaPag da criação. O MyCredit pede a devolução à instituição de pagamento e só marca a cobrança como estornada se essa devolução for aceita. Cobrança pendente, cancelada ou já estornada não pode ser estornada de novo. O estorno parcial não faz parte desta API. Ele é feito no portal MyCredit, na cobrança paga, e só está disponível para PIX da carteira MyCredit. Dá para devolver um valor menor que o pago, mais de uma vez, até completar o total. Quando a soma das devoluções chega ao valor pago, a cobrança fica estornada.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idFaturaPag

string<uuid>

required

Identificador da fatura de pagamento (UUID) gerado por sua aplicação ao criar a cobrança PIX.

Response

Estorno solicitado e aceito.

sucesso

boolean

Example:

true

data

object

Show child attributes

Estornar

curl --request DELETE \
  --url https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.mycredit.com.br/api/pix/{idFaturaPag}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "sucesso": true,
  "data": {
    "retTexto": "Estorno solicitado com sucesso"
  }
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

{
  "sucesso": false,
  "errors": "Mensagem de erro"
}

Para desenvolvedores

PIX

Crédito de clientes

Status do pagamento

Authorizations

Path Parameters

Response