Carteira e saques

Create Payout

Solicita um saque PIX ou LTC do saldo disponível. O débito do saldo é atômico. O valor máximo sacável é o campo withdrawable do GET /v1/wallet (balance - disputeBlocked - comprometido com subcontas): o saldo retido por disputas (MED) abertas ou perdidas não perdoadas não é sacável, e o valor já atribuído a subcontas também não sai pela conta principal (transfira to_master antes, ou saque pela subconta no painel). Pedidos acima do sacável são rejeitados com 400 (o campo available da resposta indica o valor sacável, e subaccountsCommitted aparece quando há valor comprometido). Saque PIX exige chave PIX verificada no dashboard (403 caso contrário). Saque LTC exige cryptoAmount e endereço LTC em formato válido. Rate limit de 10 solicitações por hora por conta (somando todas as chaves; 429 ao exceder). O sandbox aplica as MESMAS regras: valida o saldo simulado (400 com available quando não cabe), exige PIX verificado (403), DEBITA o saldo simulado e o saque aparece em GET /v1/payouts. Nada de dinheiro real se move.

POST

payouts

Create Payout

curl --request POST \
  --url https://api.purincash.com/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "pix",
  "amount": 100,
  "walletAddress": "email@exemplo.com"
}
'

import requests

url = "https://api.purincash.com/v1/payouts"

payload = {
    "method": "pix",
    "amount": 100,
    "walletAddress": "email@exemplo.com"
}
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({method: 'pix', amount: 100, walletAddress: 'email@exemplo.com'})
};

fetch('https://api.purincash.com/v1/payouts', 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.purincash.com/v1/payouts",
  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([
    'method' => 'pix',
    'amount' => 100,
    'walletAddress' => 'email@exemplo.com'
  ]),
  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.purincash.com/v1/payouts"

	payload := strings.NewReader("{\n  \"method\": \"pix\",\n  \"amount\": 100,\n  \"walletAddress\": \"email@exemplo.com\"\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.purincash.com/v1/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"method\": \"pix\",\n  \"amount\": 100,\n  \"walletAddress\": \"email@exemplo.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.purincash.com/v1/payouts")

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  \"method\": \"pix\",\n  \"amount\": 100,\n  \"walletAddress\": \"email@exemplo.com\"\n}"

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

{
  "success": true,
  "payment": {
    "id": "665f1a2b3c4d5e6f7a8b9c0d",
    "code": "PAY-A1B2C3D4",
    "amount": 100,
    "fee": 1,
    "debited": 101,
    "status": "completed",
    "endToEndId": "E12345678202603181200abcdef01234",
    "txId": "9f8e7d6c-5b4a-3928-1706-f5e4d3c2b1a0",
    "merchantName": "NOME DO RECEBEDOR",
    "recipientDocument": "12345678909",
    "isDynamic": false
  }
}

Authorizations

Authorization

string

header

required

Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

Body

application/json

amount

number

required

Valor do saque em BRL. O mínimo é o configurado para a SUA conta (R$ 5,00 por padrão; o erro de valor baixo devolve minAmount com o mínimo vigente). Máximo R$ 999.999,99. Para PIX, deve ser menor ou igual ao campo withdrawable do GET /v1/wallet (balance - disputeBlocked - comprometido com subcontas). No turbo o máximo é R$ 5.000,00 por saque. Em method "pix_code" o campo é OPCIONAL e só vale para QR estático sem valor: com valor fixo ou QR dinâmico quem manda é o código, e enviar um número diferente devolve 400 em vez de pagar (divergir do que sai é como aparece prejuízo silencioso).

Required range: 5 <= x <= 999999.99

walletAddress

string

required

Chave PIX (para method "pix") ou endereço LTC (para method "ltc"). Endereços LTC são validados por formato (legado L/M/3 ou bech32 ltc1...).

Maximum string length: 100

method

enum<string>

default:pix

Método do saque: "pix" para chave PIX, "pix_code" para pagar um código copia e cola (BR Code), "ltc" para Litecoin ou "usd" para USDT na rede BEP20 (converte o saldo BRL; a resposta do USD tem formato próprio, com o objeto withdrawal; veja o guia de Saques). Em "pix_code" o corpo muda: brCode passa a ser obrigatório no lugar de walletAddress, amount vira opcional (quem manda no valor é o código) e a taxa é SOMADA ao valor em vez de descontada dele: a resposta traz amount, fee e debited. Não disponível em sandbox.

Available options:

pix,

pix_code,

ltc,

usd

brCode

string

Obrigatório quando method é "pix_code": o copia e cola completo do PIX. Quebras de linha são ignoradas, o resto vai íntegro (é o código que carrega o destino). Limites de R$ 1,00 a R$ 5.000,00 sobre o valor que o recebedor recebe. Exige o escopo saques.pix, chave PIX da conta verificada e a conta já ter feito o primeiro saque PIX (403 caso contrário). Código apontando para destino da própria plataforma é recusado com 400 e blocked true.

confirmNotCoinbase

boolean

Obrigatório e true quando method é "usd": confirma que o endereço de destino NÃO é de exchange que rejeita BEP20 (ex. Coinbase). Sem ele o saque USD devolve 400.

cryptoAmount

number

Quantidade em LTC a sacar. Obrigatória quando method é "ltc".

Response

Só em method "pix_code": o pagamento do código foi enviado. O objeto payment traz os três números que precisam bater no seu financeiro: amount é o que o RECEBEDOR recebeu, fee é a taxa e debited é o que saiu da carteira (amount + fee). status "completed" = banco confirmou; "processing" = o PIX já saiu e a confirmação vem depois (trate como pago, não reenvie).

success

boolean

payment

object

Show child attributes

Create Payout

curl --request POST \
  --url https://api.purincash.com/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "pix",
  "amount": 100,
  "walletAddress": "email@exemplo.com"
}
'

import requests

url = "https://api.purincash.com/v1/payouts"

payload = {
    "method": "pix",
    "amount": 100,
    "walletAddress": "email@exemplo.com"
}
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({method: 'pix', amount: 100, walletAddress: 'email@exemplo.com'})
};

fetch('https://api.purincash.com/v1/payouts', 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.purincash.com/v1/payouts",
  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([
    'method' => 'pix',
    'amount' => 100,
    'walletAddress' => 'email@exemplo.com'
  ]),
  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.purincash.com/v1/payouts"

	payload := strings.NewReader("{\n  \"method\": \"pix\",\n  \"amount\": 100,\n  \"walletAddress\": \"email@exemplo.com\"\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.purincash.com/v1/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"method\": \"pix\",\n  \"amount\": 100,\n  \"walletAddress\": \"email@exemplo.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.purincash.com/v1/payouts")

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  \"method\": \"pix\",\n  \"amount\": 100,\n  \"walletAddress\": \"email@exemplo.com\"\n}"

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

{
  "success": true,
  "payment": {
    "id": "665f1a2b3c4d5e6f7a8b9c0d",
    "code": "PAY-A1B2C3D4",
    "amount": 100,
    "fee": 1,
    "debited": 101,
    "status": "completed",
    "endToEndId": "E12345678202603181200abcdef01234",
    "txId": "9f8e7d6c-5b4a-3928-1706-f5e4d3c2b1a0",
    "merchantName": "NOME DO RECEBEDOR",
    "recipientDocument": "12345678909",
    "isDynamic": false
  }
}

Visão geral

Pagamentos

Cobranças

Splits

Cartão

Assinaturas

Produtos

Entregas

Subcontas

Carteira e saques

Disputas

Sandbox

Create Payout

Authorizations

Body

Response