eko54r
b5e3a778ce
All checks were successful
Build, Push and Deploy / build-and-push (push) Successful in 3m3s
Gitea Actions Demo / Explore-Gitea-Actions (push) Successful in 16s
Build, Push and Deploy / deploy-staging (push) Successful in 32s
Build, Push and Deploy / deploy-production (push) Has been skipped
Build, Push and Deploy / cleanup (push) Successful in 1s
597 lines
14 KiB
PHP
597 lines
14 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Stripe Response.
|
|
*/
|
|
namespace Omnipay\Stripe\Message;
|
|
|
|
use Omnipay\Common\Message\AbstractResponse;
|
|
use Omnipay\Common\Message\RedirectResponseInterface;
|
|
use Omnipay\Common\Message\RequestInterface;
|
|
|
|
/**
|
|
* Stripe Response.
|
|
*
|
|
* This is the response class for all Stripe requests.
|
|
*
|
|
* @see \Omnipay\Stripe\Gateway
|
|
*/
|
|
class Response extends AbstractResponse implements RedirectResponseInterface
|
|
{
|
|
/**
|
|
* Request id
|
|
*
|
|
* @var string URL
|
|
*/
|
|
protected $requestId = null;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $headers = [];
|
|
|
|
public function __construct(RequestInterface $request, $data, $headers = [])
|
|
{
|
|
$this->request = $request;
|
|
$this->data = json_decode($data, true);
|
|
$this->headers = $headers;
|
|
}
|
|
|
|
/**
|
|
* Is the transaction successful?
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isSuccessful()
|
|
{
|
|
if ($this->isRedirect()) {
|
|
return false;
|
|
}
|
|
|
|
return !isset($this->data['error']);
|
|
}
|
|
|
|
/**
|
|
* Get the charge reference from the response of FetchChargeRequest.
|
|
*
|
|
* @deprecated 2.3.3:3.0.0 duplicate of \Omnipay\Stripe\Message\Response::getTransactionReference()
|
|
* @see \Omnipay\Stripe\Message\Response::getTransactionReference()
|
|
* @return array|null
|
|
*/
|
|
public function getChargeReference()
|
|
{
|
|
if (isset($this->data['object']) && 'charge' === $this->data['object']) {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the outcome of a charge from the response
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getOutcome()
|
|
{
|
|
if (isset($this->data['object']) && 'charge' === $this->data['object']) {
|
|
if (isset($this->data['outcome']) && !empty($this->data['outcome'])) {
|
|
return $this->data['outcome'];
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the transaction reference.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getTransactionReference()
|
|
{
|
|
if (isset($this->data['object']) && 'charge' === $this->data['object']) {
|
|
return $this->data['id'];
|
|
}
|
|
if (isset($this->data['error']) && isset($this->data['error']['charge'])) {
|
|
return $this->data['error']['charge'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the balance transaction reference.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getApplicationFeeReference()
|
|
{
|
|
if (isset($this->data['object']) && 'application_fee' === $this->data['object']) {
|
|
return $this->data['id'];
|
|
}
|
|
if (isset($this->data['error']) && isset($this->data['error']['application_fee'])) {
|
|
return $this->data['error']['application_fee'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the balance transaction reference.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getBalanceTransactionReference()
|
|
{
|
|
if (isset($this->data['object']) && 'charge' === $this->data['object']) {
|
|
return $this->data['balance_transaction'];
|
|
}
|
|
if (isset($this->data['object']) && 'balance_transaction' === $this->data['object']) {
|
|
return $this->data['id'];
|
|
}
|
|
if (isset($this->data['error']) && isset($this->data['error']['charge'])) {
|
|
return $this->data['error']['charge'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get a customer reference, for createCustomer requests.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getCustomerReference()
|
|
{
|
|
if (isset($this->data['object']) && 'customer' === $this->data['object']) {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
if (isset($this->data['object']) && 'card' === $this->data['object']) {
|
|
if (!empty($this->data['customer'])) {
|
|
return $this->data['customer'];
|
|
}
|
|
}
|
|
|
|
if (isset($this->data['object']) && 'charge' === $this->data['object']) {
|
|
if (!empty($this->data['customer'])) {
|
|
return $this->data['customer'];
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get a card reference, for createCard or createCustomer requests.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getCardReference()
|
|
{
|
|
if (isset($this->data['object']) && 'customer' === $this->data['object']) {
|
|
if (isset($this->data['default_source']) && !empty($this->data['default_source'])) {
|
|
return $this->data['default_source'];
|
|
}
|
|
|
|
if (isset($this->data['default_card']) && !empty($this->data['default_card'])) {
|
|
return $this->data['default_card'];
|
|
}
|
|
|
|
if (!empty($this->data['id'])) {
|
|
return $this->data['id'];
|
|
}
|
|
}
|
|
|
|
if (isset($this->data['object']) && 'card' === $this->data['object']) {
|
|
if (!empty($this->data['id'])) {
|
|
return $this->data['id'];
|
|
}
|
|
}
|
|
|
|
if (isset($this->data['object']) && 'charge' === $this->data['object']) {
|
|
if (! empty($this->data['source'])) {
|
|
if (!empty($this->data['source']['three_d_secure']['card'])) {
|
|
return $this->data['source']['three_d_secure']['card'];
|
|
}
|
|
|
|
if (! empty($this->data['source']['id'])) {
|
|
return $this->data['source']['id'];
|
|
}
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get a token, for createCard requests.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getToken()
|
|
{
|
|
if (isset($this->data['object']) && 'token' === $this->data['object']) {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the card data from the response.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getCard()
|
|
{
|
|
if (isset($this->data['card'])) {
|
|
return $this->data['card'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the card data from the response of purchaseRequest.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getSource()
|
|
{
|
|
if (isset($this->data['source']) && $this->data['source']['object'] == 'card') {
|
|
return $this->data['source'];
|
|
}
|
|
|
|
if (isset($this->data['object']) && 'source' === $this->data['object']) {
|
|
return $this->data;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the subscription reference from the response of CreateSubscriptionRequest.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getSubscriptionReference()
|
|
{
|
|
if (isset($this->data['object']) && $this->data['object'] == 'subscription') {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the subscription schedule reference from the response of FetchSubscriptionSchedulesRequest.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getSubscriptionSchedulesReference()
|
|
{
|
|
if (isset($this->data['object']) && $this->data['object'] == 'subscription_schedule') {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the event reference from the response of FetchEventRequest.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getEventReference()
|
|
{
|
|
if (isset($this->data['object']) && $this->data['object'] == 'event') {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the invoice reference from the response of FetchInvoiceRequest.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getInvoiceReference()
|
|
{
|
|
if (isset($this->data['object']) && $this->data['object'] == 'invoice') {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the transfer reference from the response of CreateTransferRequest,
|
|
* UpdateTransferRequest, and FetchTransferRequest.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getTransferReference()
|
|
{
|
|
if (isset($this->data['object']) && $this->data['object'] == 'transfer') {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the transfer reference from the response of CreateTransferReversalRequest,
|
|
* UpdateTransferReversalRequest, and FetchTransferReversalRequest.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getTransferReversalReference()
|
|
{
|
|
if (isset($this->data['object']) && $this->data['object'] == 'transfer_reversal') {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the list object from a result
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getList()
|
|
{
|
|
if (isset($this->data['object']) && $this->data['object'] == 'list') {
|
|
return $this->data['data'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the subscription plan from the response of CreateSubscriptionRequest.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getPlan()
|
|
{
|
|
if (isset($this->data['plan'])) {
|
|
return $this->data['plan'];
|
|
} elseif (array_key_exists('object', $this->data) && $this->data['object'] == 'plan') {
|
|
return $this->data;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get plan id
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getPlanId()
|
|
{
|
|
$plan = $this->getPlan();
|
|
|
|
if ($plan && array_key_exists('id', $plan)) {
|
|
return $plan['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get plan id
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getSourceId()
|
|
{
|
|
if (isset($this->data['object']) && 'source' === $this->data['object']) {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get invoice-item reference
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getInvoiceItemReference()
|
|
{
|
|
if (isset($this->data['object']) && $this->data['object'] == 'invoiceitem') {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the error message from the response.
|
|
*
|
|
* Returns null if the request was successful.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getMessage()
|
|
{
|
|
if (!$this->isSuccessful() && isset($this->data['error']) && isset($this->data['error']['message'])) {
|
|
return $this->data['error']['message'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the error message from the response.
|
|
*
|
|
* Returns null if the request was successful.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getCode()
|
|
{
|
|
if (!$this->isSuccessful() && isset($this->data['error']) && isset($this->data['error']['code'])) {
|
|
return $this->data['error']['code'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @return string|null
|
|
*/
|
|
public function getRequestId()
|
|
{
|
|
if (isset($this->headers['Request-Id'])) {
|
|
return $this->headers['Request-Id'][0];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the source reference
|
|
*
|
|
* @return null
|
|
*/
|
|
public function getSourceReference()
|
|
{
|
|
if (isset($this->data['object']) && 'source' === $this->data['object']) {
|
|
return $this->data['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isRedirect()
|
|
{
|
|
if (isset($this->data['object']) && 'source' === $this->data['object']) {
|
|
if ($this->cardCan3DS() || ($this->isThreeDSecureSourcePending() && $this->getRedirectUrl() !== null)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Check if card requires 3DS
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function cardCan3DS()
|
|
{
|
|
if (isset($this->data['type']) && 'card' === $this->data['type']) {
|
|
if (isset($this->data['card']['three_d_secure']) &&
|
|
in_array($this->data['card']['three_d_secure'], ['required', 'optional', 'recommended'], true)
|
|
) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Check if the ThreeDSecure source has status pending
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function isThreeDSecureSourcePending()
|
|
{
|
|
if (isset($this->data['type']) && 'three_d_secure' === $this->data['type']) {
|
|
if (isset($this->data['status']) && 'pending' === $this->data['status']) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getRedirectUrl()
|
|
{
|
|
if (isset($this->data['object']) && 'source' === $this->data['object'] &&
|
|
isset($this->data['type']) && 'three_d_secure' === $this->data['type'] &&
|
|
!empty($this->data['redirect']['url'])
|
|
) {
|
|
return $this->data['redirect']['url'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getRedirectMethod()
|
|
{
|
|
return 'GET';
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getRedirectData()
|
|
{
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the source reference of ThreeDSecure charge
|
|
*
|
|
* @return null
|
|
*/
|
|
public function getSessionId()
|
|
{
|
|
if (isset($this->data['type']) && 'three_d_secure' === $this->data['type']) {
|
|
return $this->getSourceReference();
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the coupon plan from the response of CreateCouponRequest.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getCoupon()
|
|
{
|
|
if (isset($this->data['coupon'])) {
|
|
return $this->data['coupon'];
|
|
} elseif (array_key_exists('object', $this->data) && $this->data['object'] == 'coupon') {
|
|
return $this->data;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get coupon id
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getCouponId()
|
|
{
|
|
$coupon = $this->getCoupon();
|
|
|
|
if ($coupon && array_key_exists('id', $coupon)) {
|
|
return $coupon['id'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
}
|