CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file using the Keep a CHANGELOG principles.

[Unreleased]

Deprecated

• The exception UnprocessableEntityException is deprecated in favor of DataValidationException. New exception has new method getValidationErrors which returns the errors in new format.
• The KycDocument property fileId was made deprecated.

Added

• Added new properties to Transaction: disputeTime, disputeStatus, isRebill, 3ds, riskScore, retryNumber, isReconciled, hadDiscrepancy, hasBumpOffer, hasAmountAdjustment, billingDescriptor
• Added new properties to Dispute: transaction, category, rawResponse, caseId
• Added new property to Customer: revision
• Added new properties to Invoice: revision, amountDue, autopayRetryNumber, dueReminderTime, dueReminderNumber, paymentFormUrl
• Added new properties to Subscription: revision, isTrialOnly, poNumber, renewalReminderTime, renewalReminderNumber, trialReminderTime, trialReminderNumber
• Added new property to KycDocument: documentSubtype
• Added new property to KycDocument: fileIds
• Added new method to GatewayAccountService: checkCredentials
• Added new property to Transaction: referenceData

Changed

• The Transaction property gatewayAccountId was made writable.
• Replaced PUT with PATCH in OrganizationService::update() method.

Removed

• Removed put method from OrganizationService::create() method.
• Removed OrganizationService::delete() method.
• Removed PaymentCardService::authorize() method.
• Removed PayPalAccountService::activate() method.
• Removed TransactionService::cancel() method.
• Removed PaymentCardAuthorization entity.

[2.11.0] 2021-03-03

Added

• Added new property to Plan: createdTime
• Added new property to Invoice: createdTime
• Added new property to Transaction: isMerchantInitiated
• Added new property to BrowserData: isJavaEnabled
• Added new property to RiskMetadata: browserData
• Added new property to CommonPaymentInstrument, BankAccount, PaymentCard, PayPalAccount: riskMetadata
• Added new property to PaymentToken: riskMetadata
• Added new property to Dispute: customerId
• Added new property to GatewayAccount: status

Removed

• Removed Layouts API
• Removed deprecated ApiKey property: datetimeFormat
• Removed deprecated ApiKey method: datetimeFormats
• Removed deprecated ApiKey constants: DATETIME_FORMAT_MYSQL, DATETIME_FORMAT_ISO8601, MSG_UNEXPECTED_DATETIME_FORMAT
• Removed deprecated BrowserData properties: acceptHeader, ipAddress, javaEnabled, userAgent, deviceFingerprintHash
• Removed deprecated CommonPaymentInstrument, BankAccount, PaymentCard, PayPalAccount properties: browserData

Fixed

• Added missing attribute value factories for Address: createPhoneNumbers, createEmails

[2.10.0] 2021-01-21

Added

• Added new properties to KycDocument: matchLevel, reason
• Added new properties to Transaction: arn, paymentInstruction
• Added new properties to RiskMetadata: hasMismatchedTimeZone, hasMismatchedBankCountry, hasMismatchedBillingAddressCountry
• Added new property to ApiKey: apiUser

Deprecated

• Deprecated Transaction method: setPaymentInstrument

Removed

• Removed ApiKey property: userName

[2.9.0] 2020-11-18

Added

• Added Blocklist API
• Added Plaid Credentials API
• Added Experian Credentials API
• Added Payment Instruments API
• Added PaymentToken
• Added Client::paymentTokens() factory
• Added KhelocardCardPaymentInstrument for Khelocard payment tokens
• Added new property to SubscriptionChangePlan: keepTrial

Changed

• Removed API version from request URIs. See Rebilly REST API Guide for more details.

Deprecated

• Deprecated Client::CURRENT_VERSION constant
• Deprecated Blacklist
• Deprecated PaymentCardToken
• Deprecated Client::paymentCardTokens() factory
• Deprecated Coupon method: getRedemptionCode() in favor getId()
• Deprecated Redemption method: getRedemptionCode(), setRedemptionCode() in favor getCouponId()/setCouponId()

Removed

• Removed Payment Cards Migrations API
• Removed payment methods restriction in the PaymentMethodInstrument
• Removed payment methods restriction in the GatewayAccount
• Removed deprecated PayPalAccount method: getApprovalLink
• Removed Checkout Pages API

[2.8.0] 2020-07-02

Added

• Added new AML API
• Added new Gateway Account Limit API
• Added new properties to GatewayAccount: reconciliationWindowEnabled, reconciliationWindowTtl
• Added new properties to Transaction: planIds, isDisputed, retriedTransactionId
• Added new properties to PaymentCard: fingerprint, browserData
• Added new properties to BankAccount: browserData, billingAddress
• Added new property to PayPalAccount: browserData
• Added new method to PayPalAccount: getApprovalUrl
• Added new property to LeadSource: referrer
• Added new property to GatewayAccount: additionalFilters
• Added new methods to GatewayAccount: getAdditionalFilters, setAdditionalFilters
• Added new property to GatewayAccount: digitalWallets
• Added new methods to GatewayAccount: setDigitalWallets, getDigitalWallets
• Added new properties to Invoice: transactions, poNumber, notes
• Added new property to Subscription: recentInvoice
• Added patch method to TransactionService

Deprecated

• Deprecated PayPalAccount method: getApprovalLink
• Deprecated Subscription method: cancel (use SubscriptionCancellation instead)
• Deprecated SubscriptionCancel class.

Removed

• Removed deprecated Payments API
• Removed deprecated Contacts API
• Removed Payment Instrument Validation API
• Removed SchedulePaymentService service and ScheduledPayment entity
• Removed deprecated PaymentCard properties: panFingerprint, billingContactId
• Removed deprecated BankAccount properties: contactId, address
• Removed deprecated PayPalAccount property: contactId
• Removed deprecated Invoice properties: billingContactId, deliveryContactId
• Removed deprecated Transaction properties: redirectUrls
• Removed deprecated PaymentCard method: setStatus
• Removed deprecated BankAccount method: getContact
• Removed deprecated PayPalAccount methods: getContact, setUserName
• Removed deprecated GatewayAccount methods: getAdditionalCriteria, setAdditionalCriteria, createAdditionalCriteria

[2.7.0] 2020-02-11

Added

• Added new property to SubscriptionChangePlan: quantity
• Added new properties to ApiTracking: relatedIds, requestHeaders, responseHeaders

Removed

• Removed Note entity, NoteService service

[2.6.0] 2020-01-14

Added

• Added support for empty redirect responses
• Added new property to Customer: websiteId
• Added new property to Transaction: requestId
• Added new property to Website: organizationId
• Added new property to PaymentCard: stickyGatewayAccountId
• Added CheckInstrument, AlternativeInstrument, Customer Timeline
• Added iDEAL, Klarna, Interac, Onlineueberweisen to supported alternative payment instruments
• Added description field to ValuesList
• Added reissue method to InvoiceService
• Added dueTime to InvoiceService::issue()
• Added new properties to Transaction: requestAmount, requestCurrency, purchaseAmount, purchaseCurrency, reportAmount, reportCurrency, isProcessedOutside
• Added field additionalCriteria into GatewayAccount object
• Added field dueTimeShift into BillingAnchor object
• Added getUpcomingInvoices and issueUpcomingInvoice methods to SubscriptionService
• Added recalculate method to InvoiceService
• Added EmailTemplate as a part of EmailNotification to support multi-locale emails in RulesEngine
• Added getUrlPathSegment, setUrlPathSegment, getRedirect, setRedirect, getStatus, setStatus, getIsCustomCustomerIdAllowed, setIsCustomCustomerIdAllowed method to CheckoutPage
• Added Organization-Id header to Client config

Changed

• Renamed field billingAnchor into invoiceTimeShift in Subscription object

Deprecated

• Deprecated Transaction entity method: getPaymentCardId
• Deprecated PayPalAccount entity method: setUserName
• Deprecated PaymentCard entity method: setStatus
• Deprecated CheckoutPage entity methods: getUriPath, setUriPath, getAllowCustomCustomerId, setAllowCustomCustomerId, getIsActive, setIsActive

Removed

• Removed Payments Queue API
• Removed Transaction entity method: getPayment
• Removed ValuesList field: name
• Removed field websites from GatewayAccount object
• Removed EmailNotification entity methods related to an actual EmailTemplate

[2.5.0] 2019-07-19

Fixed

• Fixed CurlHandler to support HTTP/2

[2.4.0] 2019-07-01

Fixed

• Added missing options in Client constructor.

Added

• Added custom fields to Plan
• Added new write-only property to set payment instrument from token for the Customer Resource.
• Added new property to RiskMetadata: region
• Added new properties to Customer: averageValue, paymentCount, lastPaymentTime
• Added new service WebhookCredentials
• Added new property to PaymentCardAuthorization: redirectUrl
• Added new links to PaymentCard: approvalUrl, authTransaction
• Added new property to Subscription: recentInvoiceId
• Added POST to Transaction
• Added new property to PaymentCardToken: isUsed
• Added new blacklist types to Blacklist: email-domain, bank-account, address
• Added new taxCategory to Product
• Added new property to Blacklist: expirationTime
• Added cancel method to Transaction service
• Added new properties to Invoice: retryInstruction, autopayScheduledTime
• Added resend method to WebhookTracking service
• Added merge method to Customer service
• Added new service Rule
• Added new method to AuthenticationTokenService: exchange
• Added new properties to Session: customerId, type
• Added new properties to AuthenticationToken: mode, invalidate
• Added new properties to Transaction: customFields, description, processedTime, scheduledTime, velocity, revision
• Added new properties to PaymentCard: method, panFingerprint
• Added new properties to BankAccount: accountNumberType, last4, bic, method, fingerprint, token
• Added missing getters and setters to AuthenticationToken, Transaction, PaymentCard, BankAccount
• Removed delete method from SessionService
• Added new method to SessionService: logout
• Added new method to BankAccountService: update, createFromToken

Changed

• Upgraded minimum PHP version to 7.1

Deprecated

• Deprecated Customer entity methods: getFirstName, setFirstName, getLastName, setLastName, getEmail, setEmail
• Deprecated Blacklist expiredTime property

[2.3.0] 2018-10-08

Added

• Added new properties to Plan: pricing, recurringInterval, trial, setup
• Added new property to Subscription: items
• Added new property to LeadSource: original

Changed

• Replaced magic methods like get, post with explicit defined methods.

Removed

• Removed deprecated Plan properties: expiredTime, recurringAmount, trialAmount, setupAmount, recurringPeriodUnit, recurringPeriodLength, recurringPeriodLimit, trialPeriodUnit, trialPeriodLength, contractTermUnit, contractTermLength, minQuantity, maxQuantity
• Removed LeadSources in Transactions, Invoices and Subscriptions
• Removed LeadSources endpoint and service. Adding Lead Sources now only possible via Tokens and Customers
• Removed deprecated Subscription properties: planId, quantity, billingContactId, billingContact, deliveryContactId, deliveryContact
• Removed deprecated LeadSource property: ipAddress
• Removed Notification, EmailNotification and EmailNotificationTracking.
• Deprecate setting initialInvoiceId property when creating a Subscription.

[2.2.0] 2018-08-14

Added

• Added support for subscription interim invoices.
• Added schema for subscriptions change-plan endpoint.
• Added SubscriptionChangePlan.
• Added lineItems and lineItemSubtotal to Subscription entity.
• Implemented new Subscription Cancellations API.
• Implemented Subscription-reactivations API.
• Implemented KYC Documents API.
• Implemented Gateway Account Downtime API.
• Implemented Email Notifications API.
• Added Customer Lifetime Revenue.
• Added route to ApiTracking.
• Added productId to Plan.
• Added setting status to payment card.
• Added payment instrument validation.

Removed

• Removed Subscription switch.
• Removed support for Subscription Tracking.
• Removed downtime settings in Gateway Account API.
• Removed custom fields deletion.

Fixed

• Fixed PATCH calls.
• Fixed reset-password endpoint.
• Fix coupons restrictions.

Deprecated

• Deprecated support for old subscription/{id}/cancel endpoint (SubscriptionCancel with policy).
• Deprecated Redemption's redeemedTime in favor of createdTime.

[2.1.0] 2018-01-04

• Updated Invoice methods to use websiteId and customerId
• Rename Email object to ForgotPassword and update corresponding usages.
• Fix erroneous import of wrong Email object.
• Removed Website checkoutPageUri.

[2.0.7] 2017-09-13

Added

• Added ability to configure permission of the PATCH method for the user session.
• Added missing getters and setters in the Subscription, SubscriptionSwitch, Transaction, Coupon.
• Added status property in the Invoice.
• Added DELETE method to the Contacts API.
• Added Contact Value Object which is replacement to the relations between Contact and other resource, like Transaction, Invoice and others.
• Implemented Values List API.
• Added new endpoint to change the Coupon expiration.
• Implemented Products API.
• Implemented Shipping Zone API.
• Implemented Webhooks API.
• Implemented Webhooks Tracking API.
• Implemented Risk Metadata API.

Removed

• Removed Email Credentials API, it is never used.
• Removed attribute threeDSecureType from the Transaction.

Fixed

• Fixed some erroneous properties in resources.

[2.0.6] 2017-01-07

Added

• Added support for Files and Attachments.
• Added support for Subscription resource attributes: inTrial and rebillNumber.
• Added support to delete Layout resources.
• Added support to activate a User.
• Added support to delete a WebsiteWebhook.

Changed

• Require PHP 7.1 unit tests to pass, and updated README. PHP 5.5 is at end of life and not supported by PHP. We recommend upgrading if you are using PHP 5.5. We will continue support of it for now.

Fixed

• Fixed SDK_VERSION now properly incremented.
• Fixed PaymentCardToken to properly set the method attribute.

[2.0.5] 2016-11-29

Added

• Added support for Blacklist expiredTime attribute, and deprecated expireTime attribute.
• Added support for Coupons and Discounts and Restrictions.
• Added support for Gateway object inside of Transaction response.
• Added support for LeadSource on Invoice, Payment and Subscription.
• Added support for Notes attached PaymentCard, GatewayAccount, Subscription and Transaction.
• Added support for Payment attributes retryInstruction and retryNumber, and added support for creating instructions.
• Added support for PaymentCardMigrations.

Changed

• Changed all enum values and made it consistent using kebab-case notation of naming.
• Moved support for the deprecated Website Webhooks to own object WebsiteWebhook.
• LeadSource is not an independent entity, but a child of Customer, Subscription, Invoice, or Payment.

Fixed

• Fixed bankName attribute in BankAccount.

[2.0.4] 2016-08-12

Added

• Added userId attribute to Session.

Fixed

• Fixed bankName attribute in BankAccount.

[2.0.3] 2016-07-29

Added

• Enabled Disputes API.
• Enabled Webhook Tracking API.
• Enabled Subscription Tracking API.
• Enabled API Tracking.
• Use vendor headers without additional prefixes.

Changed

• Updated Payment Tokens API, added paymentInstrument.
• Updated Gateway Accounts API, added method.
• Updated Payment Cards API, added bin.
• Updated Payments API, added missing supported methods.

Deprecated

• Since Payment Tokens resource was extended with paymentInstrument, all fields related to payment card are deprecated.
• The paymentMethods was renamed to paymentCardSchemes, all methods related to old name are deprecated.

Fixed

• Fixed Gateway payment schemes.

[2.0.2] 2016-04-28

Added

• Added User-Agent to all requests.
• Added paypal service and default payment method.
• Enabled Checkout Pages API.
• Added API keys management.
• Added autopay (boolean) attribute to Subscription entity.
• Enabled User management API and Authentication API.
• Added ability to authentication client with JWT.
• Enabled Sessions API.
• Added support of Rate limiting.
• Handle responses with PDF content.
• Enabled Gateway Accounts API.
• Enabled Custom Fields API.
• Updated Payments API, added cancel method.

Changed

• Update some resource fields.
• Updated Payments API, added status and result fields, deprecated state field.

[2.0.1-rc] 2015-09-15

Added

• Added support of pagination.
• Enabled Layouts API.
• Enabled Organizations API.
• Added RebillySignature helper.
• Added fingerprint as blacklist type.
• Enabled custom logger injection.
• Updated Customer Authentication API, added delete method to reset token.
• Updated Subscriptions API, added createdTime and updatedTime fields.
• Updated Payment Cards API, added creating card from token.
• Updated Transactions API, added result field.
• Updated Payment Cards API, added cvv field.
• Updated Tokens API, added create and expire method.
• Updated Plans API, added delete method.

Fixed

• Updated Payments API, fixed field names.
• Fixed resource factory, use decoded URL.
• Fixed response body read.
• Fixed parsing response w/o content.

[2.0.1-beta] 2015-09-15

Multiple fixes and enhancements.

[2.0.1-alpha] 2015-09-15

Initial release.