PHP 클래스 Mollie_API_Object_Payment, mollie-api-php

All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
저자: Mollie B.V. ([email protected])
파일 보기 프로젝트 열기: mollie/mollie-api-php 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$amount float The amount of the payment in EURO with 2 decimals.
$amountRefunded float | null The amount of the payment that has been refunded to the consumer, in EURO with 2 decimals. This field will be NULL if the payment can not be refunded.
$amountRemaining float | null For some payment methods this amount can be higher than the payment amount. This is possible to reimburse the costs for a return shipment to your customer for example.
$cancelledDatetime string | null Date and time the payment was cancelled in ISO-8601 format.
$createdDatetime string | null Date and time the payment was created in ISO-8601 format.
$customerId string | null The customer ID this payment is performed by.
$description string Description of the payment that is shown to the customer during the payment, and possibly on the bank or credit card statement.
$details object Details of a successfully paid payment are set here. For example, the iDEAL payment method will set $details->consumerName and $details->consumerAccount.
$expiredDatetime string | null Date and time the payment was cancelled in ISO-8601 format.
$expiryPeriod string | null The period after which the payment will expire in ISO-8601 format.
$id string Id of the payment (on the Mollie platform).
$links object
$locale string | null The locale used for this payment.
$mandateId string | null The mandate ID this payment is performed with.
$metadata object | mixed | null During creation of the payment you can set custom metadata that is stored with the payment, and given back whenever you retrieve that payment.
$method string | null If method is empty/null, the customer can pick his/her preferred payment method.
$mode string Mode of the payment, either "live" or "test" depending on the API Key that was used.
$paidDatetime string | null Date and time the payment was paid in ISO-8601 format.
$profileId string The profile ID this payment belongs to.
$recurringType string | null Either "first", "recurring", or NULL for regular payments.
$resource string
$status string The status of the payment.
$subscriptionId string | null The subscription ID this payment belongs to.

공개 메소드들

메소드 설명
canBePartiallyRefunded ( ) : boolean
canBeRefunded ( ) : boolean
getAmountRefunded ( ) : float Get the amount that is already refunded
getAmountRemaining ( ) : float Get the remaining amount that can be refunded. For some payment methods this amount can be higher than the payment amount. This is possible to reimburse the costs for a return shipment to your customer for example.
getPaymentUrl ( ) : string | null Get the payment URL where the customer can complete the payment.
hasRecurringType ( ) : boolean Check whether the 'recurringType' parameter has been defined for this payment.
hasRecurringTypeFirst ( ) : boolean Check whether 'recurringType' is set to 'first'. If a 'first' payment has been completed successfully, the consumer's account may be charged automatically using recurring payments.
hasRecurringTypeRecurring ( ) : boolean Check whether 'recurringType' is set to 'recurring'. This type of payment is processed without involving the consumer.
isCancelled ( ) : boolean Is this payment cancelled?
isChargedBack ( ) : boolean Is this payment charged back?
isExpired ( ) : boolean Is this payment expired?
isOpen ( ) : boolean Is this payment still open / ongoing?
isPaid ( ) : boolean Is this payment paid for?
isPaidOut ( ) : boolean Has the money been transferred to the bank account of the merchant?
isPending ( ) : boolean Is this payment pending?
isRefunded ( ) : boolean Is this payment (partially) refunded?

메소드 상세

canBePartiallyRefunded() 공개 메소드

public canBePartiallyRefunded ( ) : boolean
리턴 boolean

canBeRefunded() 공개 메소드

public canBeRefunded ( ) : boolean
리턴 boolean

getAmountRefunded() 공개 메소드

Get the amount that is already refunded
public getAmountRefunded ( ) : float
리턴 float

getAmountRemaining() 공개 메소드

Get the remaining amount that can be refunded. For some payment methods this amount can be higher than the payment amount. This is possible to reimburse the costs for a return shipment to your customer for example.
public getAmountRemaining ( ) : float
리턴 float

getPaymentUrl() 공개 메소드

Get the payment URL where the customer can complete the payment.
public getPaymentUrl ( ) : string | null
리턴 string | null

hasRecurringType() 공개 메소드

Check whether the 'recurringType' parameter has been defined for this payment.
public hasRecurringType ( ) : boolean
리턴 boolean

hasRecurringTypeFirst() 공개 메소드

Check whether 'recurringType' is set to 'first'. If a 'first' payment has been completed successfully, the consumer's account may be charged automatically using recurring payments.
public hasRecurringTypeFirst ( ) : boolean
리턴 boolean

hasRecurringTypeRecurring() 공개 메소드

Check whether 'recurringType' is set to 'recurring'. This type of payment is processed without involving the consumer.

isCancelled() 공개 메소드

Is this payment cancelled?
public isCancelled ( ) : boolean
리턴 boolean

isChargedBack() 공개 메소드

Is this payment charged back?
public isChargedBack ( ) : boolean
리턴 boolean

isExpired() 공개 메소드

Is this payment expired?
public isExpired ( ) : boolean
리턴 boolean

isOpen() 공개 메소드

Is this payment still open / ongoing?
public isOpen ( ) : boolean
리턴 boolean

isPaid() 공개 메소드

Is this payment paid for?
public isPaid ( ) : boolean
리턴 boolean

isPaidOut() 공개 메소드

Note: When a payment is refunded or charged back, the status 'refunded'/'charged_back' will overwrite the 'paidout' status.
public isPaidOut ( ) : boolean
리턴 boolean

isPending() 공개 메소드

Is this payment pending?
public isPending ( ) : boolean
리턴 boolean

isRefunded() 공개 메소드

Is this payment (partially) refunded?
public isRefunded ( ) : boolean
리턴 boolean

프로퍼티 상세

$amount 공개적으로 프로퍼티

The amount of the payment in EURO with 2 decimals.
public float $amount
리턴 float

$amountRefunded 공개적으로 프로퍼티

The amount of the payment that has been refunded to the consumer, in EURO with 2 decimals. This field will be NULL if the payment can not be refunded.
public float|null $amountRefunded
리턴 float | null

$amountRemaining 공개적으로 프로퍼티

For some payment methods this amount can be higher than the payment amount. This is possible to reimburse the costs for a return shipment to your customer for example.
public float|null $amountRemaining
리턴 float | null

$cancelledDatetime 공개적으로 프로퍼티

Date and time the payment was cancelled in ISO-8601 format.
public string|null $cancelledDatetime
리턴 string | null

$createdDatetime 공개적으로 프로퍼티

Date and time the payment was created in ISO-8601 format.
public string|null $createdDatetime
리턴 string | null

$customerId 공개적으로 프로퍼티

The customer ID this payment is performed by.
public string|null $customerId
리턴 string | null

$description 공개적으로 프로퍼티

Description of the payment that is shown to the customer during the payment, and possibly on the bank or credit card statement.
public string $description
리턴 string

$details 공개적으로 프로퍼티

Details of a successfully paid payment are set here. For example, the iDEAL payment method will set $details->consumerName and $details->consumerAccount.
public object $details
리턴 object

$expiredDatetime 공개적으로 프로퍼티

Date and time the payment was cancelled in ISO-8601 format.
public string|null $expiredDatetime
리턴 string | null

$expiryPeriod 공개적으로 프로퍼티

The period after which the payment will expire in ISO-8601 format.
public string|null $expiryPeriod
리턴 string | null

$id 공개적으로 프로퍼티

Id of the payment (on the Mollie platform).
public string $id
리턴 string

$locale 공개적으로 프로퍼티

The locale used for this payment.
public string|null $locale
리턴 string | null

$mandateId 공개적으로 프로퍼티

The mandate ID this payment is performed with.
public string|null $mandateId
리턴 string | null

$metadata 공개적으로 프로퍼티

During creation of the payment you can set custom metadata that is stored with the payment, and given back whenever you retrieve that payment.
public object|mixed|null $metadata
리턴 object | mixed | null

$method 공개적으로 프로퍼티

If method is empty/null, the customer can pick his/her preferred payment method.
또한 보기: Mollie_API_Object_Method
public string|null $method
리턴 string | null

$mode 공개적으로 프로퍼티

Mode of the payment, either "live" or "test" depending on the API Key that was used.
public string $mode
리턴 string

$paidDatetime 공개적으로 프로퍼티

Date and time the payment was paid in ISO-8601 format.
public string|null $paidDatetime
리턴 string | null

$profileId 공개적으로 프로퍼티

The profile ID this payment belongs to.
public string $profileId
리턴 string

$recurringType 공개적으로 프로퍼티

Either "first", "recurring", or NULL for regular payments.
public string|null $recurringType
리턴 string | null

$resource 공개적으로 프로퍼티

public string $resource
리턴 string

$status 공개적으로 프로퍼티

The status of the payment.
public string $status
리턴 string

$subscriptionId 공개적으로 프로퍼티

The subscription ID this payment belongs to.
public string|null $subscriptionId
리턴 string | null