Skip to main content
POST
/
pix
/
v1
/
payment
/
withdraw
Withdraw a PIX Payment
curl --request POST \
  --url https://api.pagou.ai/pix/v1/payment/withdraw \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "type": "PIX",
  "value": 1,
  "details": {
    "key": "<string>",
    "name": "<string>",
    "document": "<string>"
  },
  "externalId": "<string>"
}
'
import requests

url = "https://api.pagou.ai/pix/v1/payment/withdraw"

payload = {
"type": "PIX",
"value": 1,
"details": {
"key": "<string>",
"name": "<string>",
"document": "<string>"
},
"externalId": "<string>"
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'PIX',
value: 1,
details: {key: '<string>', name: '<string>', document: '<string>'},
externalId: '<string>'
})
};

fetch('https://api.pagou.ai/pix/v1/payment/withdraw', 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.pagou.ai/pix/v1/payment/withdraw",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'PIX',
'value' => 1,
'details' => [
'key' => '<string>',
'name' => '<string>',
'document' => '<string>'
],
'externalId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>"
],
]);

$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.pagou.ai/pix/v1/payment/withdraw"

payload := strings.NewReader("{\n \"type\": \"PIX\",\n \"value\": 1,\n \"details\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"document\": \"<string>\"\n },\n \"externalId\": \"<string>\"\n}")

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

req.Header.Add("apiKey", "<api-key>")
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.post("https://api.pagou.ai/pix/v1/payment/withdraw")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"PIX\",\n \"value\": 1,\n \"details\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"document\": \"<string>\"\n },\n \"externalId\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.pagou.ai/pix/v1/payment/withdraw")

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

request = Net::HTTP::Post.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"PIX\",\n \"value\": 1,\n \"details\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"document\": \"<string>\"\n },\n \"externalId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "withdrawId": "wd_aa8f7af952d0424babecf85a3aa0af8a",
  "status": "WAITING_WITHDRAW",
  "value": 3500,
  "externalId": "saque-001",
  "createdAt": "2026-02-07T10:11:12.000Z"
}
{
"type": "https://api.pagou.ai/problems/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The request contains invalid data.",
"instance": "/pix/v1/payment/withdraw",
"errors": [
{
"field": "transaction.value",
"message": "Must be greater than zero.",
"code": "invalid_type"
}
]
}
{
"type": "https://api.pagou.ai/problems/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Authentication failed for POST /pix/v1/payment/withdraw.",
"instance": "/pix/v1/payment/withdraw"
}

Authorizations

apiKey
string
header
required

Body

application/json
type
enum<string>
required
Available options:
PIX
value
number
required
Required range: x > 0
details
object
required
externalId
string
required
Minimum string length: 1

Response

Success

withdrawId
string
required
status
string
required
value
integer
required
externalId
string
required
createdAt
string
required