Overview
  • Namespace
  • Class

Namespaces

  • Omnipay
    • Pagarme
      • Message

Classes

  • AbstractRequest
  • AuthorizeRequest
  • CaptureRequest
  • CreateCardRequest
  • CreateCustomerRequest
  • InstallmentsRequest
  • PurchaseRequest
  • RefundRequest
  • Response
  • VoidRequest

Class VoidRequest

Pagarme Void Request

Pagarme does not support voiding, per se, but we treat it as a full refund.

See RefundRequest for additional information

Example -- note this example assumes that the purchase has been successful and that the transaction ID returned from the purchase is held in $sale_id. See PurchaseRequest for the first part of this example transaction:

// Do a void transaction on the gateway
  $transaction = $gateway->void(array(
      'transactionReference' => $sale_id,
  ));
  $response = $transaction->send();
  if ($response->isSuccessful()) {
      echo "Void transaction was successful!\n";
      $void_id = $response->getTransactionReference();
      echo "Transaction reference = " . $void_id . "\n";
  }
Omnipay\Common\Message\AbstractRequest
Extended by Omnipay\Pagarme\Message\AbstractRequest
Extended by Omnipay\Pagarme\Message\RefundRequest
Extended by Omnipay\Pagarme\Message\VoidRequest
Namespace: Omnipay\Pagarme\Message
See: Omnipay\Pagarme\Message\RefundRequest
See: Omnipay\Pagarme\Gateway
Link: https://docs.pagar.me/api/?shell#estorno-de-transao
Located at Message/VoidRequest.php

Methods summary

public
# getData( )

Overrides

Omnipay\Pagarme\Message\RefundRequest::getData

Methods inherited from Omnipay\Pagarme\Message\RefundRequest

getEndpoint()

Methods inherited from Omnipay\Pagarme\Message\AbstractRequest

createResponse(), extractAddress(), extractDddPhone(), getApiKey(), getCard(), getCardData(), getCardHash(), getCustomer(), getCustomerData(), getCustomerReference(), getHttpMethod(), getMetadata(), insertApiKeyToData(), sendData(), setApiKey(), setCard(), setCardHash(), setCustomer(), setCustomerReference(), setMetadata()

Properties summary

Properties inherited from Omnipay\Pagarme\Message\AbstractRequest

$endpoint

API documentation generated by ApiGen