Cancelar Depósito

Você pode cancelar um pedido de depósito manualmente através do endpoint a seguir.

Pedidos com mais de 24 horas Pendente a GruPay atualizará automáticamente para VENCIDO.

Parâmetros de entrada

  • Nome
    reference *
    Tipo
    uuid
    Descrição
    Referência do depósito a ser cancelado.
  • Nome
    reason *
    Tipo
    string
    Descrição
    Motivo do cancelamento. Máximo de 70 caracteres.
POST /api/v1/payment/order-cancel
$client = new Client();

$headers = [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'x-client-id' => '20d80764-61aa-4ca1-ac32-3c91c4772a1e',
    'x-client-secret' => 'MTIwZDgwNzY1LTY43GMtMGNj1S2hYuAyLThaOTNjNDc9M2EyZQ==',
    'signature' => '17362932487ee2379217c2b75bd335d602f7bed76d6b0095283017b7986bad1d'
];

$body = '{
    "reference": "dc7f584c-985d-423a-b643-686bca6ed79a",
    "reason": "Expirou ou Cliente cancelou pagamento"
';

$request = new Request('POST', 'https://api.grupay.app/v1/payment/order-cancel', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
200 Sucesso
{
    "success": true,
    "message": "Order cancelled successfully."
}
404 Depósito não encontrado
{
    "success": false,
    "message": "Order not found or already processed."
}