Transferência via PIX

Permite transferir via PIX para chaves.

Parâmetros de entrada

Nome

reference *

Tipo

uuid

Descrição

Código único da transação para referencia.
Nome

value *

Tipo

int

Descrição

Valor para ser transferido da sua carteira para terceiros.
Nome

webhookUrl *

Tipo

string

Descrição

URL de retorno para notificação de eventos. O retorno é feito via POST, com o payload do evento.
Nome

pix_key_type *

Tipo

string

Descrição

Tipo de chave PIX do destinatário. Podendo ser CPF, CNPJ, E-mail, Aleatório ou Telefone.
Nome

pix_key *

Tipo

string

Descrição

Chave PIX do destinatário.
Nome

document_validation *

Tipo

string

Descrição

CPF ou CNPJ do destinatário. Proprietário da chave PIX informada.

POST /api/v1/account/transfer/pix

$client = new Client();
$headers = [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'x-client-id' => '20d80764-61aa-4ca1-ac32-3c91c4772a1e',
    'x-client-secret' => 'MTIwZDgwNzY1LTY43GMtMGNj1S2hYuAyLThaOTNjNDc9M2EyZQ==',
];
$body = '{
  "reference": "eedb304f-595e-4e51-b1cb-9f43929f1a12",
  "value": 2000,
  "webhookUrl": "https://seu-site.com/webhook",
  "pix_key_type": "cpf",
  "pix_key": "99999999999",
  "document_validation": "99999999999"
}';
$request = new Request('POST', 'https://api.grupay.app/v1/transfer/pix', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

200 Sucesso

{
    "success": true,
    "reference": "a3d3701a-cb58-41f6-bce1-ceabaf10ca48"
    "hash": "0f2c0f75-0d90-41b1-a05e-03c7ca1daqb6"
}

422 Saldo insuficiente para cobrir as taxas

{
    "success": false,
    "message": "Insufficient balance to cover cashout and fees"
}