Pular para o conteúdo principal
POST
/
v2
/
transfers
Create a Transfer
curl --request POST \
  --url https://api.pagou.ai/v2/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pix_key_value": "<string>",
  "amount": 4503599627370996,
  "description": "<string>",
  "external_ref": "<string>",
  "notify_url": "<string>",
  "origin": "<string>"
}
'
import requests

url = "https://api.pagou.ai/v2/transfers"

payload = {
    "pix_key_value": "<string>",
    "amount": 4503599627370996,
    "description": "<string>",
    "external_ref": "<string>",
    "notify_url": "<string>",
    "origin": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pix_key_value: '<string>',
    amount: 4503599627370996,
    description: '<string>',
    external_ref: '<string>',
    notify_url: '<string>',
    origin: '<string>'
  })
};

fetch('https://api.pagou.ai/v2/transfers', 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/v2/transfers",
  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([
    'pix_key_value' => '<string>',
    'amount' => 4503599627370996,
    'description' => '<string>',
    'external_ref' => '<string>',
    'notify_url' => '<string>',
    'origin' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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/v2/transfers"

	payload := strings.NewReader("{\n  \"pix_key_value\": \"<string>\",\n  \"amount\": 4503599627370996,\n  \"description\": \"<string>\",\n  \"external_ref\": \"<string>\",\n  \"notify_url\": \"<string>\",\n  \"origin\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <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.post("https://api.pagou.ai/v2/transfers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pix_key_value\": \"<string>\",\n  \"amount\": 4503599627370996,\n  \"description\": \"<string>\",\n  \"external_ref\": \"<string>\",\n  \"notify_url\": \"<string>\",\n  \"origin\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.pagou.ai/v2/transfers")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pix_key_value\": \"<string>\",\n  \"amount\": 4503599627370996,\n  \"description\": \"<string>\",\n  \"external_ref\": \"<string>\",\n  \"notify_url\": \"<string>\",\n  \"origin\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Autorizações

​
Authorization
string
header
obrigatório

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

Corpo

application/json
​
pix_key_type
enum<string>
obrigatório

Type of the PIX key that identifies the recipient account.

Opções disponíveis:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
​
pix_key_value
string
obrigatório

Value of the PIX key corresponding to the selected pix_key_type.

Required string length: 1 - 77
​
amount
integer
obrigatório

Transfer amount in cents. Minimum of 1000 (10.00).

Intervalo obrigatório: 1000 <= x <= 9007199254740991
​
description
string

Optional description for the transfer, shown in reports and statements.

Maximum string length: 140
​
external_ref
string

Optional idempotency key or external reference from your system. If omitted, a value is generated automatically.

Maximum string length: 100
​
notify_url
string | null

Optional HTTPS URL that will receive webhook notifications for this transfer.

Maximum string length: 2048
​
origin
string | null

Optional origin identifier for the transfer (e.g. your platform name or channel).

Maximum string length: 50

Resposta

Success

Generic success response payload.