PHP 인터페이스 Bitpay\InvoiceInterface

파일 보기 프로젝트 열기: bitpay/php-client 0 사용 예제들

공개 메소드들

메소드 설명
getBtcPaid ( )
getBtcPrice ( ) : string The amount of bitcoins being requested for payment of this invoice (same as the price if the merchant set the price in BTC).
getBuyer ( ) : BuyerInterface
getBuyerAddress1 ( ) : string These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
getBuyerAddress2 ( ) : string These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
getBuyerCity ( ) : string These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
getBuyerCountry ( ) : string These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
getBuyerEmail ( ) : string These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
getBuyerName ( ) : string These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
getBuyerPhone ( ) : string These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
getBuyerState ( ) : string These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
getBuyerZip ( ) : string These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
getCurrency ( ) : bitpay\CurrencyInterface This is the currency code set for the price setting.  The pricing currencies currently supported are USD, EUR, BTC, and all of the codes listed on this page: https://bitpay.com/bitcoin­exchange­rates
getCurrentTime ( ) : DateTime The current time on the BitPay.com system (by subtracting the current time from the expiration time, the amount of time remaining for payment can be determined). Time format is “2014­01­01T19:01:01.123Z”.
getExceptionStatus ( )
getExpirationTime ( ) : DateTime The time at which the invoice expires and no further payment will be accepted (in milliseconds since midnight January 1, 1970). Currently, all invoices are valid for 15 minutes. Time format is “2014­01­01T19:01:01.123Z”.
getId ( ) : string The unique id of the invoice assigned by bitpay.com
getInvoiceTime ( ) : DateTime The time the invoice was created in milliseconds since midnight January 1, 1970. Time format is “2014­01­01T19:01:01.123Z”.
getItem ( ) : bitpay\ItemInterface
getItemCode ( ) : string Used to display an item SKU code or part number to the buyer. Maximum string length is 100 characters.
getItemDesc ( ) : string Used to display an item description to the buyer. Maximum string length is 100 characters.
getNotificationEmail ( ) : string Bitpay.com will send an email to this email address when the invoice status changes.
getNotificationUrl ( ) : string A URL to send status update messages to your server (this must be an https URL, unencrypted http URLs or any other type of URL is not supported).
getOrderId ( ) : string Used to display your public order number to the buyer on the BitPay invoice. In the merchant Account Summary page, this value is used to identify the ledger entry. Maximum string length is 100 characters.
getPosData ( ) : array | object A passthru variable provided by the merchant and designed to be used by the merchant to correlate the invoice with an order or other object in their system.
getPrice ( ) : string This is the amount that is required to be collected from the buyer. Note, if this is specified in a currency other than BTC, the price will be converted into BTC at market exchange rates to determine the amount collected from the buyer.
getRate ( )
getRedirectUrl ( ) : string This is the URL for a return link that is displayed on the receipt, to return the shopper back to your website after a successful purchase. This could be a page specific to the order, or to their account.
getStatus ( ) : string The current invoice status. The possible states are described earlier in this document.
getToken ( )
getTransactionSpeed ( ) : string default value: set in your https://bitpay.com/order­settings, the default value set in your merchant dashboard is “medium”.
getUrl ( ) : string An https URL where the invoice can be viewed.
isFullNotifications ( ) : boolean default value: false ● true: Notifications will be sent on every status change.
isPhysical ( ) : boolean default value: false ● true: Indicates a physical item will be shipped (or picked up) ● false: Indicates that nothing is to be shipped for this order

메소드 상세

getBtcPaid() 공개 메소드

public getBtcPaid ( )

getBtcPrice() 공개 메소드

The amount of bitcoins being requested for payment of this invoice (same as the price if the merchant set the price in BTC).
public getBtcPrice ( ) : string
리턴 string

getBuyer() 공개 메소드

public getBuyer ( ) : BuyerInterface
리턴 BuyerInterface

getBuyerAddress1() 공개 메소드

These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
사용 중단:
public getBuyerAddress1 ( ) : string
리턴 string

getBuyerAddress2() 공개 메소드

These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
사용 중단:
public getBuyerAddress2 ( ) : string
리턴 string

getBuyerCity() 공개 메소드

These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
사용 중단:
public getBuyerCity ( ) : string
리턴 string

getBuyerCountry() 공개 메소드

These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
사용 중단:
public getBuyerCountry ( ) : string
리턴 string

getBuyerEmail() 공개 메소드

These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
사용 중단:
public getBuyerEmail ( ) : string
리턴 string

getBuyerName() 공개 메소드

These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
사용 중단:
public getBuyerName ( ) : string
리턴 string

getBuyerPhone() 공개 메소드

These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
사용 중단:
public getBuyerPhone ( ) : string
리턴 string

getBuyerState() 공개 메소드

These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
사용 중단:
public getBuyerState ( ) : string
리턴 string

getBuyerZip() 공개 메소드

These fields are used for display purposes only and will be shown on the invoice if provided. Maximum string length of each field is 100 characters.
사용 중단:
public getBuyerZip ( ) : string
리턴 string

getCurrency() 공개 메소드

This is the currency code set for the price setting.  The pricing currencies currently supported are USD, EUR, BTC, and all of the codes listed on this page: https://bitpay.com/bitcoin­exchange­rates
public getCurrency ( ) : bitpay\CurrencyInterface
리턴 bitpay\CurrencyInterface

getCurrentTime() 공개 메소드

The current time on the BitPay.com system (by subtracting the current time from the expiration time, the amount of time remaining for payment can be determined). Time format is “2014­01­01T19:01:01.123Z”.
public getCurrentTime ( ) : DateTime
리턴 DateTime

getExceptionStatus() 공개 메소드

public getExceptionStatus ( )

getExpirationTime() 공개 메소드

The time at which the invoice expires and no further payment will be accepted (in milliseconds since midnight January 1, 1970). Currently, all invoices are valid for 15 minutes. Time format is “2014­01­01T19:01:01.123Z”.
public getExpirationTime ( ) : DateTime
리턴 DateTime

getId() 공개 메소드

The unique id of the invoice assigned by bitpay.com
public getId ( ) : string
리턴 string

getInvoiceTime() 공개 메소드

The time the invoice was created in milliseconds since midnight January 1, 1970. Time format is “2014­01­01T19:01:01.123Z”.
public getInvoiceTime ( ) : DateTime
리턴 DateTime

getItem() 공개 메소드

public getItem ( ) : bitpay\ItemInterface
리턴 bitpay\ItemInterface

getItemCode() 공개 메소드

Used to display an item SKU code or part number to the buyer. Maximum string length is 100 characters.
사용 중단:
public getItemCode ( ) : string
리턴 string

getItemDesc() 공개 메소드

Used to display an item description to the buyer. Maximum string length is 100 characters.
사용 중단:
public getItemDesc ( ) : string
리턴 string

getNotificationEmail() 공개 메소드

Bitpay.com will send an email to this email address when the invoice status changes.
public getNotificationEmail ( ) : string
리턴 string

getNotificationUrl() 공개 메소드

Bitpay.com will send a POST request with a JSON encoding of the invoice to this URL when the invoice status changes.
public getNotificationUrl ( ) : string
리턴 string

getOrderId() 공개 메소드

Used to display your public order number to the buyer on the BitPay invoice. In the merchant Account Summary page, this value is used to identify the ledger entry. Maximum string length is 100 characters.
public getOrderId ( ) : string
리턴 string

getPosData() 공개 메소드

Maximum string length is 100 characters.
public getPosData ( ) : array | object
리턴 array | object

getPrice() 공개 메소드

This is the amount that is required to be collected from the buyer. Note, if this is specified in a currency other than BTC, the price will be converted into BTC at market exchange rates to determine the amount collected from the buyer.
public getPrice ( ) : string
리턴 string

getRate() 공개 메소드

public getRate ( )

getRedirectUrl() 공개 메소드

This is the URL for a return link that is displayed on the receipt, to return the shopper back to your website after a successful purchase. This could be a page specific to the order, or to their account.
public getRedirectUrl ( ) : string
리턴 string

getStatus() 공개 메소드

The current invoice status. The possible states are described earlier in this document.
public getStatus ( ) : string
리턴 string

getToken() 공개 메소드

public getToken ( )

getTransactionSpeed() 공개 메소드

● “high”: An invoice is considered to be "confirmed" immediately upon receipt of payment. ● “medium”: An invoice is considered to be "confirmed" after 1 block confirmation (~10 minutes). ● “low”: An invoice is considered to be "confirmed" after 6 block confirmations (~1 hour). NOTE: Orders are posted to your Account Summary after 6 block confirmations regardless of this setting.
public getTransactionSpeed ( ) : string
리턴 string

getUrl() 공개 메소드

An https URL where the invoice can be viewed.
public getUrl ( ) : string
리턴 string

isFullNotifications() 공개 메소드

● false: Notifications are only sent when an invoice is confirmed (according to the “transactionSpeed” setting).
public isFullNotifications ( ) : boolean
리턴 boolean

isPhysical() 공개 메소드

default value: false ● true: Indicates a physical item will be shipped (or picked up) ● false: Indicates that nothing is to be shipped for this order
사용 중단:
public isPhysical ( ) : boolean
리턴 boolean