paypal-server-sdk 0.6.0 → 0.7.0

data/lib/paypal_server_sdk/models/payment_source_response.rb

@@ -167,5 +167,24 @@ module PaypalServerSdk
                                 google_pay: google_pay,
                                 venmo: venmo)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}, paypal: #{@paypal}, bancontact: #{@bancontact}, blik:"\
+      " #{@blik}, eps: #{@eps}, giropay: #{@giropay}, ideal: #{@ideal}, mybank: #{@mybank}, p24:"\
+      " #{@p24}, sofort: #{@sofort}, trustly: #{@trustly}, apple_pay: #{@apple_pay}, google_pay:"\
+      " #{@google_pay}, venmo: #{@venmo}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}, paypal: #{@paypal.inspect}, bancontact:"\
+      " #{@bancontact.inspect}, blik: #{@blik.inspect}, eps: #{@eps.inspect}, giropay:"\
+      " #{@giropay.inspect}, ideal: #{@ideal.inspect}, mybank: #{@mybank.inspect}, p24:"\
+      " #{@p24.inspect}, sofort: #{@sofort.inspect}, trustly: #{@trustly.inspect}, apple_pay:"\
+      " #{@apple_pay.inspect}, google_pay: #{@google_pay.inspect}, venmo: #{@venmo.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/payment_supplementary_data.rb

@@ -46,5 +46,17 @@ module PaypalServerSdk
       # Create object from extracted values.
       PaymentSupplementaryData.new(related_ids: related_ids)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} related_ids: #{@related_ids}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} related_ids: #{@related_ids.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/payment_token_request.rb

@@ -10,8 +10,9 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
-    # Customer in merchant's or partner's system of records.
-    # @return [CustomerRequest]
+    # This object defines a customer in your system. Use it to manage customer
+    # profiles, save payment methods and contact details.
+    # @return [Customer]
     attr_accessor :customer
 
     # The payment method to vault with the instrument details.
@@ -50,11 +51,24 @@ module PaypalServerSdk
       # Extract variables from the hash.
       payment_source = PaymentTokenRequestPaymentSource.from_hash(hash['payment_source']) if
         hash['payment_source']
-      customer = CustomerRequest.from_hash(hash['customer']) if hash['customer']
+      customer = Customer.from_hash(hash['customer']) if hash['customer']
 
       # Create object from extracted values.
       PaymentTokenRequest.new(payment_source: payment_source,
                               customer: customer)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer}, payment_source: #{@payment_source}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer.inspect}, payment_source:"\
+      " #{@payment_source.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/payment_token_request_card.rb

@@ -42,15 +42,6 @@ module PaypalServerSdk
     # @return [Address]
     attr_accessor :billing_address
 
-    # The portable international postal address. Maps to
-    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
-    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
-    # the autocomplete
-    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
-    # ntrols-the-autocomplete-attribute).
-    # @return [Object]
-    attr_accessor :network_transaction_reference
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -60,8 +51,6 @@ module PaypalServerSdk
       @_hash['security_code'] = 'security_code'
       @_hash['brand'] = 'brand'
       @_hash['billing_address'] = 'billing_address'
-      @_hash['network_transaction_reference'] =
-        'network_transaction_reference'
       @_hash
     end
 
@@ -74,7 +63,6 @@ module PaypalServerSdk
         security_code
         brand
         billing_address
-        network_transaction_reference
       ]
     end
 
@@ -84,18 +72,13 @@ module PaypalServerSdk
     end
 
     def initialize(name: SKIP, number: SKIP, expiry: SKIP, security_code: SKIP,
-                   brand: SKIP, billing_address: SKIP,
-                   network_transaction_reference: SKIP)
+                   brand: SKIP, billing_address: SKIP)
       @name = name unless name == SKIP
       @number = number unless number == SKIP
       @expiry = expiry unless expiry == SKIP
       @security_code = security_code unless security_code == SKIP
       @brand = brand unless brand == SKIP
       @billing_address = billing_address unless billing_address == SKIP
-      unless network_transaction_reference == SKIP
-        @network_transaction_reference =
-          network_transaction_reference
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -109,8 +92,6 @@ module PaypalServerSdk
       security_code = hash.key?('security_code') ? hash['security_code'] : SKIP
       brand = hash.key?('brand') ? hash['brand'] : SKIP
       billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
-      network_transaction_reference =
-        hash.key?('network_transaction_reference') ? hash['network_transaction_reference'] : SKIP
 
       # Create object from extracted values.
       PaymentTokenRequestCard.new(name: name,
@@ -118,8 +99,22 @@ module PaypalServerSdk
                                   expiry: expiry,
                                   security_code: security_code,
                                   brand: brand,
-                                  billing_address: billing_address,
-                                  network_transaction_reference: network_transaction_reference)
+                                  billing_address: billing_address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, number: #{@number}, expiry: #{@expiry}, security_code:"\
+      " #{@security_code}, brand: #{@brand}, billing_address: #{@billing_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, number: #{@number.inspect}, expiry:"\
+      " #{@expiry.inspect}, security_code: #{@security_code.inspect}, brand: #{@brand.inspect},"\
+      " billing_address: #{@billing_address.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/payment_token_request_payment_source.rb

@@ -55,5 +55,17 @@ module PaypalServerSdk
       PaymentTokenRequestPaymentSource.new(card: card,
                                            token: token)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}, token: #{@token}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}, token: #{@token.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/payment_token_response.rb

@@ -13,8 +13,9 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :id
 
-    # Customer in merchant's or partner's system of records.
-    # @return [CustomerRequest]
+    # This object defines a customer in your system. Use it to manage customer
+    # profiles, save payment methods and contact details.
+    # @return [CustomerResponse]
     attr_accessor :customer
 
     # The vaulted payment method details.
@@ -63,7 +64,7 @@ module PaypalServerSdk
 
       # Extract variables from the hash.
       id = hash.key?('id') ? hash['id'] : SKIP
-      customer = CustomerRequest.from_hash(hash['customer']) if hash['customer']
+      customer = CustomerResponse.from_hash(hash['customer']) if hash['customer']
       payment_source = PaymentTokenResponsePaymentSource.from_hash(hash['payment_source']) if
         hash['payment_source']
       # Parameter is an array, so we need to iterate through it
@@ -83,5 +84,19 @@ module PaypalServerSdk
                                payment_source: payment_source,
                                links: links)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, customer: #{@customer}, payment_source: #{@payment_source},"\
+      " links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, customer: #{@customer.inspect}, payment_source:"\
+      " #{@payment_source.inspect}, links: #{@links.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/payment_token_response_payment_source.rb

@@ -10,7 +10,7 @@ module PaypalServerSdk
     private_constant :SKIP
 
     # Full representation of a Card Payment Token including network token.
-    # @return [CardPaymentToken]
+    # @return [CardPaymentTokenEntity]
     attr_accessor :card
 
     # Full representation of a Card Payment Token including network token.
@@ -25,10 +25,6 @@ module PaypalServerSdk
     # @return [ApplePayPaymentToken]
     attr_accessor :apple_pay
 
-    # Full representation of a Bank Payment Token.
-    # @return [Hash]
-    attr_accessor :bank
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -36,7 +32,6 @@ module PaypalServerSdk
       @_hash['paypal'] = 'paypal'
       @_hash['venmo'] = 'venmo'
       @_hash['apple_pay'] = 'apple_pay'
-      @_hash['bank'] = 'bank'
       @_hash
     end
 
@@ -47,7 +42,6 @@ module PaypalServerSdk
         paypal
         venmo
         apple_pay
-        bank
       ]
     end
 
@@ -56,13 +50,11 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(card: SKIP, paypal: SKIP, venmo: SKIP, apple_pay: SKIP,
-                   bank: SKIP)
+    def initialize(card: SKIP, paypal: SKIP, venmo: SKIP, apple_pay: SKIP)
       @card = card unless card == SKIP
       @paypal = paypal unless paypal == SKIP
       @venmo = venmo unless venmo == SKIP
       @apple_pay = apple_pay unless apple_pay == SKIP
-      @bank = bank unless bank == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -70,18 +62,30 @@ module PaypalServerSdk
       return nil unless hash
 
       # Extract variables from the hash.
-      card = CardPaymentToken.from_hash(hash['card']) if hash['card']
+      card = CardPaymentTokenEntity.from_hash(hash['card']) if hash['card']
       paypal = PaypalPaymentToken.from_hash(hash['paypal']) if hash['paypal']
       venmo = VenmoPaymentToken.from_hash(hash['venmo']) if hash['venmo']
       apple_pay = ApplePayPaymentToken.from_hash(hash['apple_pay']) if hash['apple_pay']
-      bank = hash.key?('bank') ? hash['bank'] : SKIP
 
       # Create object from extracted values.
       PaymentTokenResponsePaymentSource.new(card: card,
                                             paypal: paypal,
                                             venmo: venmo,
-                                            apple_pay: apple_pay,
-                                            bank: bank)
+                                            apple_pay: apple_pay)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}, paypal: #{@paypal}, venmo: #{@venmo}, apple_pay:"\
+      " #{@apple_pay}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}, paypal: #{@paypal.inspect}, venmo:"\
+      " #{@venmo.inspect}, apple_pay: #{@apple_pay.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/payment_token_status.rb

@@ -0,0 +1,36 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The status of the payment token.
+  class PaymentTokenStatus
+    PAYMENT_TOKEN_STATUS = [
+      # A setup token is initialized with minimal information, more data must be
+      # added to the setup-token to be vaulted
+      CREATED = 'CREATED'.freeze,
+
+      # A contingecy on payer approval is required before the payment method can
+      # be saved.
+      PAYER_ACTION_REQUIRED = 'PAYER_ACTION_REQUIRED'.freeze,
+
+      # Setup token is ready to be vaulted. If a buyer approval contigency was
+      # returned, it is has been approved.
+      APPROVED = 'APPROVED'.freeze,
+
+      # The payment token has been vaulted.
+      VAULTED = 'VAULTED'.freeze,
+
+      # A vaulted payment method token has been tokenized for short term (one
+      # time) use.
+      TOKENIZED = 'TOKENIZED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payments_capture.rb

@@ -0,0 +1,252 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # A captured payment.
+  class PaymentsCapture < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the captured payment.
+    # @return [CaptureStatus]
+    attr_accessor :status
+
+    # The details of the captured payment status.
+    # @return [CaptureStatusDetails]
+    attr_accessor :status_details
+
+    # The PayPal-generated ID for the captured payment.
+    # @return [String]
+    attr_accessor :id
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # The API caller-provided external invoice number for this order. Appears in
+    # both the payer's transaction history and the emails that the payer
+    # receives.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # The API caller-provided external ID. Used to reconcile API
+    # caller-initiated transactions with PayPal transactions. Appears in
+    # transaction and settlement reports.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # Reference values used by the card network to identify a transaction.
+    # @return [NetworkTransactionReference]
+    attr_accessor :network_transaction_reference
+
+    # The level of protection offered as defined by [PayPal Seller Protection
+    # for
+    # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protectio
+    # n).
+    # @return [SellerProtection]
+    attr_accessor :seller_protection
+
+    # Indicates whether you can make additional captures against the authorized
+    # payment. Set to `true` if you do not intend to capture additional payments
+    # against the authorization. Set to `false` if you intend to capture
+    # additional payments against the authorization.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :final_capture
+
+    # The detailed breakdown of the capture activity. This is not available for
+    # transactions that are in pending state.
+    # @return [SellerReceivableBreakdown]
+    attr_accessor :seller_receivable_breakdown
+
+    # The funds that are held on behalf of the merchant.
+    # @return [DisbursementMode]
+    attr_accessor :disbursement_mode
+
+    # An array of related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # The processor response information for payment requests, such as direct
+    # credit card transactions.
+    # @return [PaymentsProcessorResponse]
+    attr_accessor :processor_response
+
+    # The date and time, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @return [String]
+    attr_accessor :create_time
+
+    # The date and time, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @return [String]
+    attr_accessor :update_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['status_details'] = 'status_details'
+      @_hash['id'] = 'id'
+      @_hash['amount'] = 'amount'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['network_transaction_reference'] =
+        'network_transaction_reference'
+      @_hash['seller_protection'] = 'seller_protection'
+      @_hash['final_capture'] = 'final_capture'
+      @_hash['seller_receivable_breakdown'] = 'seller_receivable_breakdown'
+      @_hash['disbursement_mode'] = 'disbursement_mode'
+      @_hash['links'] = 'links'
+      @_hash['processor_response'] = 'processor_response'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        status_details
+        id
+        amount
+        invoice_id
+        custom_id
+        network_transaction_reference
+        seller_protection
+        final_capture
+        seller_receivable_breakdown
+        disbursement_mode
+        links
+        processor_response
+        create_time
+        update_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, status_details: SKIP, id: SKIP, amount: SKIP,
+                   invoice_id: SKIP, custom_id: SKIP,
+                   network_transaction_reference: SKIP, seller_protection: SKIP,
+                   final_capture: false, seller_receivable_breakdown: SKIP,
+                   disbursement_mode: DisbursementMode::INSTANT, links: SKIP,
+                   processor_response: SKIP, create_time: SKIP,
+                   update_time: SKIP)
+      @status = status unless status == SKIP
+      @status_details = status_details unless status_details == SKIP
+      @id = id unless id == SKIP
+      @amount = amount unless amount == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      unless network_transaction_reference == SKIP
+        @network_transaction_reference =
+          network_transaction_reference
+      end
+      @seller_protection = seller_protection unless seller_protection == SKIP
+      @final_capture = final_capture unless final_capture == SKIP
+      unless seller_receivable_breakdown == SKIP
+        @seller_receivable_breakdown =
+          seller_receivable_breakdown
+      end
+      @disbursement_mode = disbursement_mode unless disbursement_mode == SKIP
+      @links = links unless links == SKIP
+      @processor_response = processor_response unless processor_response == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_details = CaptureStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      if hash['network_transaction_reference']
+        network_transaction_reference = NetworkTransactionReference.from_hash(hash['network_transaction_reference'])
+      end
+      seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
+        hash['seller_protection']
+      final_capture = hash['final_capture'] ||= false
+      if hash['seller_receivable_breakdown']
+        seller_receivable_breakdown = SellerReceivableBreakdown.from_hash(hash['seller_receivable_breakdown'])
+      end
+      disbursement_mode =
+        hash['disbursement_mode'] ||= DisbursementMode::INSTANT
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (LinkDescription.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      processor_response = PaymentsProcessorResponse.from_hash(hash['processor_response']) if
+        hash['processor_response']
+      create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsCapture.new(status: status,
+                          status_details: status_details,
+                          id: id,
+                          amount: amount,
+                          invoice_id: invoice_id,
+                          custom_id: custom_id,
+                          network_transaction_reference: network_transaction_reference,
+                          seller_protection: seller_protection,
+                          final_capture: final_capture,
+                          seller_receivable_breakdown: seller_receivable_breakdown,
+                          disbursement_mode: disbursement_mode,
+                          links: links,
+                          processor_response: processor_response,
+                          create_time: create_time,
+                          update_time: update_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_details: #{@status_details}, id: #{@id}, amount:"\
+      " #{@amount}, invoice_id: #{@invoice_id}, custom_id: #{@custom_id},"\
+      " network_transaction_reference: #{@network_transaction_reference}, seller_protection:"\
+      " #{@seller_protection}, final_capture: #{@final_capture}, seller_receivable_breakdown:"\
+      " #{@seller_receivable_breakdown}, disbursement_mode: #{@disbursement_mode}, links:"\
+      " #{@links}, processor_response: #{@processor_response}, create_time: #{@create_time},"\
+      " update_time: #{@update_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}, id:"\
+      " #{@id.inspect}, amount: #{@amount.inspect}, invoice_id: #{@invoice_id.inspect}, custom_id:"\
+      " #{@custom_id.inspect}, network_transaction_reference:"\
+      " #{@network_transaction_reference.inspect}, seller_protection:"\
+      " #{@seller_protection.inspect}, final_capture: #{@final_capture.inspect},"\
+      " seller_receivable_breakdown: #{@seller_receivable_breakdown.inspect}, disbursement_mode:"\
+      " #{@disbursement_mode.inspect}, links: #{@links.inspect}, processor_response:"\
+      " #{@processor_response.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payments_payment_advice_code.rb

@@ -0,0 +1,42 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The declined payment transactions might have payment advice codes. The card
+  # networks, like Visa and Mastercard, return payment advice codes.
+  class PaymentsPaymentAdviceCode
+    PAYMENTS_PAYMENT_ADVICE_CODE = [
+      # For Mastercard, expired card account upgrade or portfolio sale
+      # conversion. Obtain new account information before next billing cycle.
+      PAYMENTADVICE_01 = '01'.freeze,
+
+      # For Mastercard, over credit limit or insufficient funds. Retry the
+      # transaction 72 hours later. For Visa, the card holder wants to stop only
+      # one specific payment in the recurring payment relationship. The merchant
+      # must NOT resubmit the same transaction. The merchant can continue the
+      # billing process in the subsequent billing period.
+      PAYMENTADVICE_02 = '02'.freeze,
+
+      # For Mastercard, account closed as fraudulent. Obtain another type of
+      # payment from customer due to account being closed or fraud. Possible
+      # reason: Account closed as fraudulent. For Visa, the card holder wants to
+      # stop all recurring payment transactions for a specific merchant. Stop
+      # recurring payment requests.
+      PAYMENTADVICE_03 = '03'.freeze,
+
+      # For Mastercard, the card holder has been unsuccessful at canceling
+      # recurring payment through merchant. Stop recurring payment requests. For
+      # Visa, all recurring payments were canceled for the card number
+      # requested. Stop recurring payment requests.
+      PAYMENTADVICE_21 = '21'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end