Overview
  • Namespace
  • Class

Namespaces

  • Omnipay
    • Pagarme
      • Message

Classes

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

Class InstallmentsRequest

Pagarme Calculate Installments Request

You can use Pagar.me API to calculate installments for a purchase.

// Do a GET request on the gateway
  $transaction = $gateway->calculateInstallments(array(
      'max_installments'   => 12,
      'free_installments'  => 3,
      'interest_rate'      => 1.12,
      'amount'             => '1200.00',
  ));

  $response = $transaction->send();

  if ($response->isSuccessful()) {
      echo "Calculate Installments request was successful!\n";
      $installments = $response->getCalculatedInstallments();
      echo "Calculated Installments = " . $installments . "\n";
  }
Omnipay\Common\Message\AbstractRequest
Extended by Omnipay\Pagarme\Message\AbstractRequest
Extended by Omnipay\Pagarme\Message\InstallmentsRequest
Namespace: Omnipay\Pagarme\Message
See: Omnipay\Pagarme\Gateway
Link: https://docs.pagar.me/api/?shell#estados-das-transaes
Located at Message/InstallmentsRequest.php

Methods summary

public float
# getInterestRate( )

Get Interest Rate.

Get Interest Rate.

Returns

float
public Omnipay\Pagarme\Message\InstallmentsRequest
# setInterestRate( float $value )

Set Interest Rate.

Set Interest Rate.

Parameters

$value

Returns

Omnipay\Pagarme\Message\InstallmentsRequest
provides a fluent interface.
public integer
# getMaxInstallments( )

Get Max Installments.

Get Max Installments.

Returns

integer
public Omnipay\Pagarme\Message\InstallmentsRequest
# setMaxInstallments( integer $value )

Set Max Installments.

Set Max Installments.

Parameters

$value

Returns

Omnipay\Pagarme\Message\InstallmentsRequest
provides a fluent interface.
public integer
# getFreeInstallments( )

Get Free Installments.

Get Free Installments.

Returns

integer
public Omnipay\Pagarme\Message\InstallmentsRequest
# setFreeInstallments( integer $value )

Set Free Installments.

Set Free Installments.

Parameters

$value

Returns

Omnipay\Pagarme\Message\InstallmentsRequest
provides a fluent interface.
public string
# getHttpMethod( )

Get HTTP method used by InstallmentsRequest.

Get HTTP method used by InstallmentsRequest.

Returns

string

Overrides

Omnipay\Pagarme\Message\AbstractRequest::getHttpMethod
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(), getMetadata(), insertApiKeyToData(), sendData(), setApiKey(), setCard(), setCardHash(), setCustomer(), setCustomerReference(), setMetadata()

Properties summary

Properties inherited from Omnipay\Pagarme\Message\AbstractRequest

$endpoint

API documentation generated by ApiGen