Class Response

Pagarme Response

This is the response class for all Pagarme requests.

Omnipay\Common\Message\AbstractResponse

Omnipay\Pagarme\Message\Response

Namespace: Omnipay\Pagarme\Message
See: Omnipay\Pagarme\Gateway
Located at Message/Response.php

Methods summary

`public boolean`	# `isSuccessful( )` Is the transaction successful? Is the transaction successful? Returns boolean
`public string\|null`	# `getTransactionReference( )` Get the transaction reference. Get the transaction reference. Returns string\|null
`public string\|null`	# `getCardReference( )` Get a card reference, for createCard or createCustomer requests. Get a card reference, for createCard or createCustomer requests. Returns string\|null
`public string\|null`	# `getCustomerReference( )` Get a customer reference, for createCustomer requests. Get a customer reference, for createCustomer requests. Returns string\|null
`public string\|null`	# `getMessage( )` Get the error message from the response. Get the error message from the response. Returns null if the request was successful. Returns string\|null
`public array\|null`	# `getBoleto( )` Get the boleto_url, boleto_barcode and boleto_expiration_date in the transaction object. Get the boleto_url, boleto_barcode and boleto_expiration_date in the transaction object. Returns array\|null the boleto_url, boleto_barcode and boleto_expiration_date
`public array\|null`	# `getCalculatedInstallments( )` Get the Calculted Installments provided by Pagar.me API. Get the Calculted Installments provided by Pagar.me API. Returns array\|null the calculated installments

`public boolean`	# `isSuccessful( )` Is the transaction successful? Is the transaction successful? Returns boolean
`public string\|null`	# `getTransactionReference( )` Get the transaction reference. Get the transaction reference. Returns string\|null
`public string\|null`	# `getCardReference( )` Get a card reference, for createCard or createCustomer requests. Get a card reference, for createCard or createCustomer requests. Returns string\|null
`public string\|null`	# `getCustomerReference( )` Get a customer reference, for createCustomer requests. Get a customer reference, for createCustomer requests. Returns string\|null
`public string\|null`	# `getMessage( )` Get the error message from the response. Get the error message from the response. Returns null if the request was successful. Returns string\|null
`public array\|null`	# `getBoleto( )` Get the boleto_url, boleto_barcode and boleto_expiration_date in the transaction object. Get the boleto_url, boleto_barcode and boleto_expiration_date in the transaction object. Returns array\|null the boleto_url, boleto_barcode and boleto_expiration_date
`public array\|null`	# `getCalculatedInstallments( )` Get the Calculted Installments provided by Pagar.me API. Get the Calculted Installments provided by Pagar.me API. Returns array\|null the calculated installments