Payouts
Cancel a payout
Before we start, there are some important notes:
- the transactions should have PENDING status and not marked as IN PROCESSING
DELETE
/
v1.1
/
payout
Cancel a payout
curl --request DELETE \
--url https://api.paymee.com.br/v1.1/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-token: <x-api-token>' \
--data '
{
"reason": "Customer requested cancellation",
"uuid": "83abc908-9233-4b66-b455-2339809886b1"
}
'import requests
url = "https://api.paymee.com.br/v1.1/payout"
payload = {
"reason": "Customer requested cancellation",
"uuid": "83abc908-9233-4b66-b455-2339809886b1"
}
headers = {
"x-api-key": "<x-api-key>",
"x-api-token": "<x-api-token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {
'x-api-key': '<x-api-key>',
'x-api-token': '<x-api-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reason: 'Customer requested cancellation',
uuid: '83abc908-9233-4b66-b455-2339809886b1'
})
};
fetch('https://api.paymee.com.br/v1.1/payout', 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/payout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'Customer requested cancellation',
'uuid' => '83abc908-9233-4b66-b455-2339809886b1'
]),
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/payout"
payload := strings.NewReader("{\n \"reason\": \"Customer requested cancellation\",\n \"uuid\": \"83abc908-9233-4b66-b455-2339809886b1\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://api.paymee.com.br/v1.1/payout")
.header("x-api-key", "<x-api-key>")
.header("x-api-token", "<x-api-token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Customer requested cancellation\",\n \"uuid\": \"83abc908-9233-4b66-b455-2339809886b1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paymee.com.br/v1.1/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Customer requested cancellation\",\n \"uuid\": \"83abc908-9233-4b66-b455-2339809886b1\"\n}"
response = http.request(request)
puts response.read_body{
"status": 0,
"message": "success"
}Headers
Example:
"your-x-api-key"
Example:
"your-x-api-token"
Body
application/json
⌘I
Cancel a payout
curl --request DELETE \
--url https://api.paymee.com.br/v1.1/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-token: <x-api-token>' \
--data '
{
"reason": "Customer requested cancellation",
"uuid": "83abc908-9233-4b66-b455-2339809886b1"
}
'import requests
url = "https://api.paymee.com.br/v1.1/payout"
payload = {
"reason": "Customer requested cancellation",
"uuid": "83abc908-9233-4b66-b455-2339809886b1"
}
headers = {
"x-api-key": "<x-api-key>",
"x-api-token": "<x-api-token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {
'x-api-key': '<x-api-key>',
'x-api-token': '<x-api-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reason: 'Customer requested cancellation',
uuid: '83abc908-9233-4b66-b455-2339809886b1'
})
};
fetch('https://api.paymee.com.br/v1.1/payout', 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/payout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'Customer requested cancellation',
'uuid' => '83abc908-9233-4b66-b455-2339809886b1'
]),
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/payout"
payload := strings.NewReader("{\n \"reason\": \"Customer requested cancellation\",\n \"uuid\": \"83abc908-9233-4b66-b455-2339809886b1\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://api.paymee.com.br/v1.1/payout")
.header("x-api-key", "<x-api-key>")
.header("x-api-token", "<x-api-token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Customer requested cancellation\",\n \"uuid\": \"83abc908-9233-4b66-b455-2339809886b1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paymee.com.br/v1.1/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Customer requested cancellation\",\n \"uuid\": \"83abc908-9233-4b66-b455-2339809886b1\"\n}"
response = http.request(request)
puts response.read_body{
"status": 0,
"message": "success"
}
