Overview
  • Namespace
  • Class

Namespaces

  • Omnipay
    • Pagarme
      • Message

Classes

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

Class AuthorizeRequest

Pagarme Authorize Request

An Authorize request is similar to a purchase request but the charge issues an authorization (or pre-authorization), and no money is transferred. The transaction will need to be captured later in order to effect payment. Uncaptured transactions expire in 5 days.

Either a card object or card_id is required by default. Otherwise, you must provide a card_hash, like the ones returned by Pagarme.js or use the boleto's payment method.

Pagarme gateway supports only two types of "payment_method":

  • credit_card
  • boleto

Optionally, you can provide the customer details to use the antifraude feature. These details is passed using the following attributes available on credit card object:

  • firstName
  • lastName
  • name
  • birthday
  • gender
  • address1 (must be in the format "street, street_number and neighborhood")
  • address2 (used to specify the optional parameter "street_complementary")
  • postcode
  • phone (must be in the format "DDD PhoneNumber" e.g. "19 98888 5555")
  • holder_document_number (CPF or CNPJ)

Example:

// Create a gateway for the Pagarme Gateway
  // (routes to GatewayFactory::create)
  $gateway = Omnipay::create('Pagarme');

  // Initialise the gateway
  $gateway->initialize(array(
      'apiKey' => 'MyApiKey',
  ));

  // Create a credit card object
  // This card can be used for testing.
  $card = new CreditCard(array(
              'firstName'    => 'Example',
              'lastName'     => 'Customer',
              'number'       => '4242424242424242',
              'expiryMonth'  => '01',
              'expiryYear'   => '2020',
              'cvv'          => '123',
              'email'        => 'customer@example.com',
              'address1'     => 'Street name, Street number, Complementary',
              'address2'     => 'Neighborhood',
              'postcode'     => '05443100',
              'phone'        => '19 3242 8855',
              'holder_document_number' => '214.278.589-40',
  ));

  // Do an authorize transaction on the gateway
  $transaction = $gateway->authorize(array(
      'amount'           => '10.00',
      'soft_descriptor'  => 'test',
      'payment_method'   => 'credit_card',
      'card'             => $card,
      'metadata'         => array(
                                'product_id' => 'ID1111',
                                'invoice_id' => 'IV2222',
                            ),
  ));
  $response = $transaction->send();
  if ($response->isSuccessful()) {
      echo "Authorize transaction was successful!\n";
      $sale_id = $response->getTransactionReference();
      $customer_id = $response->getCustomerReference();
      $card_id = $response->getCardReference();
      echo "Transaction reference = " . $sale_id . "\n";
  }
Omnipay\Common\Message\AbstractRequest
Extended by Omnipay\Pagarme\Message\AbstractRequest
Extended by Omnipay\Pagarme\Message\AuthorizeRequest

Direct known subclasses

Omnipay\Pagarme\Message\PurchaseRequest

Namespace: Omnipay\Pagarme\Message
See: https://docs.pagar.me/capturing-card-data/
See: Omnipay\Pagarme\Gateway
See: Omnipay\Pagarme\Message\CaptureRequest
Link: https://docs.pagar.me/api/?shell#objeto-transaction
Located at Message/AuthorizeRequest.php

Methods summary

public string
# getPostbackUrl( )

Get postback URL.

Get postback URL.

Returns

string
public Omnipay\Pagarme\Message\AuthorizeRequest
# setPostbackUrl( string $value )

Set postback URL.

Set postback URL.

Parameters

$value

Returns

Omnipay\Pagarme\Message\AuthorizeRequest
provides a fluent interface.
public integer
# getInstallments( )

Get installments.

Get installments.

Returns

integer
the number of installments
public Omnipay\Pagarme\Message\AuthorizeRequest
# setInstallments( integer $value )

Set Installments.

Set Installments.

The number must be between 1 and 12. If the payment method is boleto defaults to 1.

Parameters

$value

Returns

Omnipay\Pagarme\Message\AuthorizeRequest
provides a fluent interface.
public string
# getSoftDescriptor( )

Get soft description.

Get soft description.

Returns

string
small description
public Omnipay\Pagarme\Message\AuthorizeRequest
# setSoftDescriptor( string $value )

Set soft description.

Set soft description.

The Pagarme gateway allow 13 characters in the soft_descriptor. The provided string will be truncated if lengh > 13.

Parameters

$value

Returns

Omnipay\Pagarme\Message\AuthorizeRequest
provides a fluent interface.
public string
# getBoletoExpirationDate( $format = 'Y-m-d\TH:i:s' )

Get the boleto expiration date

Get the boleto expiration date

Returns

string
boleto expiration date
public Omnipay\Pagarme\Message\AuthorizeRequest
# setBoletoExpirationDate( string $value )

Set the boleto expiration date

Set the boleto expiration date

Parameters

$value
defaults to atual date + 7 days

Returns

Omnipay\Pagarme\Message\AuthorizeRequest
provides a fluent interface
public
# getData( )
public
# getEndpoint( )

Overrides

Omnipay\Pagarme\Message\AbstractRequest::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