Request a sale refund

PUT

v1.1

transactions

{saleUUID}

refund

Request a sale refund

curl --request PUT \
  --url https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data @- <<EOF
{
  "amount": 150,
  "reason": "shopper's request"
}
EOF

import requests

url = "https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund"

payload = {
    "amount": 150,
    "reason": "shopper's request"
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-api-token": "<x-api-token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-api-token': '<x-api-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({amount: 150, reason: 'shopper\'s request'})
};

fetch('https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund', 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://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 150,
    'reason' => 'shopper\'s request'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>",
    "x-api-token: <x-api-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund"

	payload := strings.NewReader("{\n  \"amount\": 150,\n  \"reason\": \"shopper's request\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-api-token", "<x-api-token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund")
  .header("x-api-key", "<x-api-key>")
  .header("x-api-token", "<x-api-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 150,\n  \"reason\": \"shopper's request\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 150,\n  \"reason\": \"shopper's request\"\n}"

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

{
  "status": 0,
  "message": "success",
  "uuid": "a3b59529-ac56-3e24-9011-320456dd9491",
  "currency": "BRL",
  "originalAmount": 11,
  "totalToRefund": 11,
  "currentBalance": 16495.84,
  "discounts": 0,
  "shopper": {
    "bankDetails": {
      "account": "12345-6",
      "branch": "1234"
    },
    "document": {
      "type": "CPF",
      "number": "00000000000"
    },
    "email": "JOHN DOE",
    "phone": {
      "type": "MOBILE",
      "number": "11999990000"
    }
  }
}

Headers

x-api-key

string

required

Example:

"your-x-api-key"

x-api-token

string

required

Example:

"your-x-api-token"

Path Parameters

saleUUID

string

required

UUID of the sale to be refunded

Body

application/json

amount

number

required

Amount to refund (≤ original sale total)

Example:

150

reason

string

Refund reason (optional)

Maximum string length: 255

Example:

"shopper's request"

callbackURL

string

Callback URL (optional)

Maximum string length: 255

Example:

"https://merchant.com/refund/callback"

Response

refund request accepted

status

enum<number>

Response status code.

0 – success
‑1 – validation failure
998 – transaction not found
1000 – transaction not PAID

Available options:

0,

-1,

998,

1000

Example:

0

message

string

Response message

Example:

"success"

uuid

string

Refund transaction UUID

Example:

"a3b59529-ac56-3e24-9011-320456dd9491"

currency

string

Currency code

Example:

"BRL"

originalAmount

number

Original sale total

Example:

11

totalToRefund

number

Total amount already refunded (after this request)

Example:

11

currentBalance

number

Merchant balance after the request

Example:

16495.84

discounts

number

Discounts applied to sale

Example:

0

shopper

object

Shopper information

Show child attributes

Request a sale refund

curl --request PUT \
  --url https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data @- <<EOF
{
  "amount": 150,
  "reason": "shopper's request"
}
EOF

import requests

url = "https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund"

payload = {
    "amount": 150,
    "reason": "shopper's request"
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-api-token": "<x-api-token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-api-token': '<x-api-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({amount: 150, reason: 'shopper\'s request'})
};

fetch('https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund', 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://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 150,
    'reason' => 'shopper\'s request'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>",
    "x-api-token: <x-api-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund"

	payload := strings.NewReader("{\n  \"amount\": 150,\n  \"reason\": \"shopper's request\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-api-token", "<x-api-token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund")
  .header("x-api-key", "<x-api-key>")
  .header("x-api-token", "<x-api-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 150,\n  \"reason\": \"shopper's request\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 150,\n  \"reason\": \"shopper's request\"\n}"

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

{
  "status": 0,
  "message": "success",
  "uuid": "a3b59529-ac56-3e24-9011-320456dd9491",
  "currency": "BRL",
  "originalAmount": 11,
  "totalToRefund": 11,
  "currentBalance": 16495.84,
  "discounts": 0,
  "shopper": {
    "bankDetails": {
      "account": "12345-6",
      "branch": "1234"
    },
    "document": {
      "type": "CPF",
      "number": "00000000000"
    },
    "email": "JOHN DOE",
    "phone": {
      "type": "MOBILE",
      "number": "11999990000"
    }
  }
}

API Documentation

Checkout

Payouts

Loan

Transactions

Payment Methods

Financial

Webhooks and Callbacks

Payer Information

Pix Automatic (Recurrence)

Headers

Path Parameters

Body

Response