ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / lab2454c / crypto.keyreum.com / vendor / mollie / mollie-api-php / src / Resources

<?php

namespace Mollie\Api\Resources;

use Mollie\Api\Exceptions\ApiException;
use Mollie\Api\MollieApiClient;
use Mollie\Api\Types\SettlementStatus;

class Settlement extends BaseResource
{
    /**
     * @var string
     */
    public $resource;

/**
     * Id of the settlement.
     *
     * @var string
     */
    public $id;

/**
     * The settlement reference. This corresponds to an invoice that's in your Dashboard.
     *
     * @var string
     */
    public $reference;

/**
     * UTC datetime the payment was created in ISO-8601 format.
     *
     * @example "2013-12-25T10:30:54+00:00"
     * @var string
     */
    public $createdAt;

/**
     * The date on which the settlement was settled, in ISO 8601 format. When requesting the open settlement or next settlement the return value is null.
     *
     * @example "2013-12-25T10:30:54+00:00"
     * @var string|null
     */
    public $settledAt;

/**
     * Status of the settlement.
     *
     * @var string
     */
    public $status;

/**
     * Total settlement amount in euros.
     *
     * @var \stdClass
     */
    public $amount;

/**
     * Revenues and costs nested per year, per month, and per payment method.
     *
     * @var \stdClass
     */
    public $periods;

/**
     * The ID of the invoice on which this settlement is invoiced, if it has been invoiced.
     *
     * @var string|null
     */
    public $invoiceId;

/**
     * @var \stdClass
     */
    public $_links;

/**
     * Is this settlement still open?
     *
     * @return bool
     */
    public function isOpen()
    {
        return $this->status === SettlementStatus::STATUS_OPEN;
    }

/**
     * Is this settlement pending?
     *
     * @return bool
     */
    public function isPending()
    {
        return $this->status === SettlementStatus::STATUS_PENDING;
    }

/**
     * Is this settlement paidout?
     *
     * @return bool
     */
    public function isPaidout()
    {
        return $this->status === SettlementStatus::STATUS_PAIDOUT;
    }

/**
     * Is this settlement failed?
     *
     * @return bool
     */
    public function isFailed()
    {
        return $this->status === SettlementStatus::STATUS_FAILED;
    }

/**
     * Retrieves all payments associated with this settlement
     *
     * @param null $limit
     * @param array $parameters
     * @return PaymentCollection
     * @throws \Mollie\Api\Exceptions\ApiException
     */
    public function payments($limit = null, array $parameters = [])
    {
        return $this->client->settlementPayments->pageForId($this->id, null, $limit, $parameters);
    }

/**
     * Retrieves all refunds associated with this settlement
     *
     * @return RefundCollection
     * @throws ApiException
     */
    public function refunds()
    {
        if (! isset($this->_links->refunds->href)) {
            return new RefundCollection($this->client, 0, null);
        }

$result = $this->client->performHttpCallToFullUrl(MollieApiClient::HTTP_GET, $this->_links->refunds->href);

return ResourceFactory::createCursorResourceCollection(
            $this->client,
            $result->_embedded->refunds,
            Refund::class,
            $result->_links
        );
    }

/**
     * Retrieves all chargebacks associated with this settlement
     *
     * @return ChargebackCollection
     * @throws ApiException
     */
    public function chargebacks()
    {
        if (! isset($this->_links->chargebacks->href)) {
            return new ChargebackCollection($this->client, 0, null);
        }

$result = $this->client->performHttpCallToFullUrl(MollieApiClient::HTTP_GET, $this->_links->chargebacks->href);

return ResourceFactory::createCursorResourceCollection(
            $this->client,
            $result->_embedded->chargebacks,
            Chargeback::class,
            $result->_links
        );
    }

/**
     * Retrieves all captures associated with this settlement
     *
     * @return CaptureCollection
     * @throws ApiException
     */
    public function captures()
    {
        if (! isset($this->_links->captures->href)) {
            return new CaptureCollection($this->client, 0, null);
        }

$result = $this->client->performHttpCallToFullUrl(MollieApiClient::HTTP_GET, $this->_links->captures->href);

return ResourceFactory::createCursorResourceCollection(
            $this->client,
            $result->_embedded->captures,
            Capture::class,
            $result->_links
        );
    }
}

[-] CurrentProfile.php [edit]
[-] OrganizationCollection.php [edit]
[-] SubscriptionCollection.php [edit]
[+] ..
[-] Permission.php [edit]
[-] MethodPrice.php [edit]
[-] Settlement.php [edit]
[-] CursorCollection.php [edit]
[-] CustomerCollection.php [edit]
[-] RefundCollection.php [edit]
[-] Refund.php [edit]
[-] CaptureCollection.php [edit]
[-] Method.php [edit]
[-] Order.php [edit]
[-] Subscription.php [edit]
[-] PaymentLink.php [edit]
[-] BaseResource.php [edit]
[-] Onboarding.php [edit]
[-] BaseCollection.php [edit]
[-] Customer.php [edit]
[-] OrderLine.php [edit]
[-] Profile.php [edit]
[-] Issuer.php [edit]
[-] Mandate.php [edit]
[-] ShipmentCollection.php [edit]
[-] IssuerCollection.php [edit]
[-] PermissionCollection.php [edit]
[-] InvoiceCollection.php [edit]
[-] Capture.php [edit]
[-] MethodCollection.php [edit]
[-] PaymentCollection.php [edit]
[-] PaymentLinkCollection.php [edit]
[-] OrderCollection.php [edit]
[-] ResourceFactory.php [edit]
[-] MandateCollection.php [edit]
[-] ChargebackCollection.php [edit]
[-] Payment.php [edit]
[-] Organization.php [edit]
[-] Invoice.php [edit]
[-] ProfileCollection.php [edit]
[-] OrderLineCollection.php [edit]
[-] MethodPriceCollection.php [edit]
[-] Chargeback.php [edit]
[-] Shipment.php [edit]
[-] SettlementCollection.php [edit]