Depósito via PIX

Permite gerar uma cobrança via PIX diretamente em sua carteira digital.

Parâmetros de entrada

Nome

reference *

Tipo

uuid

Descrição

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

valueInCents *

Tipo

int

Descrição

Especifique o valor a ser cobrado, em centavos. Por exemplo, para R$ 20,00, utilize o valor 2000.
Nome

webhookUrl *

Tipo

url

Descrição

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

client *

Tipo

array

Descrição

Array de dados do cliente. Os dados são utilizados para validação.
Nome

client.name *

Tipo

string

Descrição

Nome do cliente.
Nome

client.document *

Tipo

string

Descrição

CPF do cliente. Não informe pontos ou traços.
Nome

expire_days

Tipo

int

Descrição

Opcional - Dias para expirar pedido.
Nome

client.phoneNumber

Tipo

string

Descrição

Opcional - Telefone do cliente. Não informe pontos ou traços.
Nome

client.email

Tipo

string

Descrição

Opcional - E-mail do cliente.
Nome

address

Tipo

array

Descrição

Opcional - Array de dados do endereço do cliente. Os dados são utilizados para validação.
Nome

split

Tipo

array

Descrição

Opcional - Array de dados do split de pagamento.
Nome

split.username

Tipo

string

Descrição

Nome de usuário do recebedor. O usuário deve existir na plataforma.
Nome

split.percentageSplit

Tipo

string

Descrição

Percentual de split do pagamento. O valor deve ser um número entre 1 e 99.

POST /api/v1/payment/create/pix

$client = new Client();
$headers = [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'x-client-id' => '20d80764-61aa-4ca1-ac32-3c91c4772a1e',
    'x-client-secret' => 'MTIwZDgwNzY1LTY43GMtMGNj1S2hYuAyLThaOTNjNDc9M2EyZQ==',
    'signature' => '5acb59fbcdadd489286bfdae5f6e5ea0b7652670cd7515e7172c5618163d4e6d'
];
$body = '{
  "reference": "dc7f584c-985d-423a-b643-686bca6ed79a",
  "valueInCents": 2000,
  "webhookUrl": "https://meu-site.com/webhook",
  "expire_days": 1,
  "client": {
    "name": "Letícia Luiza Viana",
    "document": "50039211010",
    "phoneNumber": "62994730687",
    "email": "[email protected]",
    "address": {
      "codIbge": 5208707,
      "street": "Rua Paraíba",
      "number": "150",
      "complement": "",
      "zipCode": "74663-520",
      "neighborhood": "Goiânia 2",
      "city": "Goiânia",
      "state": "GO"
    },
   "split": {
      "username": "fulano",
      "percentageSplit": 50
   }
  }
}';
$request = new Request('POST', 'https://api.grupay.app/v1/payment/create/pix', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

200 Sucesso

{
    "reference": "dc7f584c-985d-423a-b643-686bca6ed79a",
    "link": "https://app.grupay.app/checkout/pix/eadac2de-d74f-4cde-81bf-5ffd8a77c9d7",
    "pix_copy_paste": "00020101021226930014BR.GOV.BCB.PIX2571spi-qrcode.bb.com.br/spi/pj/v2/89f9a34727c742f79a594c29b460694452040000530398654042.005802BR5901*6013FLORIANOPOLIS61088801510062070503***6304DFF0",
    "pix_image_base64": "iVBORw0KGgoAAAANSUhEUgAAAUAAAAFAAQMAAAD3XjfpAAAABlBMVEUEAgT8/vxJvsdeAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAD5ElEQVRoge1aMa7qQAx0RJEyR9ibkIshgcTF4CZ7hJQpIvxnxssj4TWv+EUsJdJDL2S2MPaOPZM1/+NlB/AAHsAD+CdgNbOTz910KbMNXvun3ysf1nn0Gx4OmYD4u9eej+azXcyfWOKP4Vas87v7KxUQsd7duslK/xiw5DXcrH/ZtTrjt3M6YO0fdkGYE6J2JvMM4HweUgJdKbSRYRqiRvaWEre5gKpHbK5ThIkCxDp+YHP9LtydA8kUgfn98YtSdg6Mi1+yHk+IGusQ9VLmbsPhGYBRgDOZAk8U5mK6sORSQOmZgNhX2EjYQ9VGMEX/nEAS43TFhiOb5wKy9hz3C0NvGMR8xXfIqHWpgGJuMQXivxWtE6Vr3ZopEgA5FlgLk9sMj7nXPPrsKuoEQI/mYxh57Mzd9OIqbLPC8iwrSskAnGMi5TZ7cIgD7TnnHjRb1uOYCVgVsLMAFSDQp6pkGpO57a67B/asRxSlB8+pDXFAtWixn8LNAERcS5SihA+1gmkJsresOTwDMGSCKpPCR31Wyg7obw7fPRApXKB5rAkfY+IYtX1zeAIgCcGM6DbyiMM5h/av9zZLA4TwgWJjrOQ+Ke0mfJzNNhcQxIZwe8440nPgjHvjcIqIVXdNAOTUdrHQCi2ZinVRd7W187F/IDuQdIG0gvQ1p23envngk8IEQNkBFNlNKzgdHLEghjivuYAou3CiRBJKJvbVA/UYLNilAuK+OQZOD4TORw0pp59jXY+7B9Z32S1hq3GmKwpdhbqRe/sHqrs6RTa5z2VFayzVXlsL8f0D6RFCiI5c8sLcI/oW94EPrawLd//AGmPBM1yORcaU08w1ap5NPWYAxtTmTSvIWwOHo7GyPFeeVAIgJalcjqYV5LLhY5HIXnfXDEBxuMQatULLI64it/DjsGcAyi00jjxF4lTvono2JFptIvI8QNoB4jk1Vg93YKYafXNGJiC21LUZHB7vPReT5vnm8AxATZ8brYAvqVBlsK3JPgEQfH3VK+jSHDW+AFFGxxiDMgGNmqf/0QrkB9MvIfQmhbsH1h93gAFfowr7p8YgcnguIAc2hr6oDRXX2zW9JWwuWyKg699QPz5p0JZZcCnB4Z+XnxmArkzFjD1RKwwex1RkifgjF9Blf/A2NheS6ZLWj62+TgAMNSoBxwGhzQb6Ebb6OgUQf/eYDZyNlZODzIJmiWyPSewdqEM2jFpagWYuqVCvQWUjejqgTnAFK9CTUrMNh93zAVWFepvzc/zJ4yxXlwrIegzDU2fr9EG5bZJ3/dfRop0DgylGnn6wd2OVqOvbdJcI+KfrAB7AA3gA/yPwHzOvLEAhRa56AAAAAElFTkSuQmCC"
}

403 Assinatura inválida

{
    "success": false,
    "message": "Invalid signature"
}