Class: ActiveMerchant::Billing::Integrations::WorldPay::Notification

### Home Classes Methods

### In Files

- lib/active_merchant/billing/integrations/world_pay/notification.rb

### Parent

ActiveMerchant::Billing::Integrations::Notification

### Methods

- #account
- #acknowledge
- #address
- #address_status
- #card_type
- #complete?
- #country
- #country_status
- #currency
- #custom_params
- #cvv_status
- #email_address
- #fax_number
- #gross
- #item_id
- #name
- #phone_number
- #postcode
- #postcode_status
- #received_at
- #security_key
- #status
- #test?
- #transaction_id

### Class/Module Index

Quicksearch

- ActiveMerchant
- ActiveMerchant::Billing
- ActiveMerchant::Billing::AVSResult
- ActiveMerchant::Billing::BarclaysEpdqGateway
- ActiveMerchant::Billing::BarclaysEpdqGateway::Document
- ActiveMerchant::Billing::BarclaysEpdqGateway::Parser
- ActiveMerchant::Billing::Base
- ActiveMerchant::Billing::BeanstreamGateway
- ActiveMerchant::Billing::BeanstreamInteracGateway
- ActiveMerchant::Billing::BeanstreamInteracResponse
- ActiveMerchant::Billing::BluePayGateway
- ActiveMerchant::Billing::BogusGateway
- ActiveMerchant::Billing::BraintreeBlueGateway
- ActiveMerchant::Billing::BraintreeGateway
- ActiveMerchant::Billing::BraintreeOrangeGateway
- ActiveMerchant::Billing::CVVResult
- ActiveMerchant::Billing::CardSaveGateway
- ActiveMerchant::Billing::CardStreamGateway
- ActiveMerchant::Billing::Check
- ActiveMerchant::Billing::CreditCard
- ActiveMerchant::Billing::CreditCardFormatting
- ActiveMerchant::Billing::CreditCardMethods
- ActiveMerchant::Billing::CreditCardMethods::ClassMethods
- ActiveMerchant::Billing::CyberSourceGateway
- ActiveMerchant::Billing::DataCashGateway
- ActiveMerchant::Billing::EfsnetGateway
- ActiveMerchant::Billing::ElavonGateway
- ActiveMerchant::Billing::EpayGateway
- ActiveMerchant::Billing::EwayGateway
- ActiveMerchant::Billing::EwayManagedGateway
- ActiveMerchant::Billing::EwayManagedGateway::EwayResponse
- ActiveMerchant::Billing::ExactGateway
- ActiveMerchant::Billing::FederatedCanadaGateway
- ActiveMerchant::Billing::FirstPayGateway
- ActiveMerchant::Billing::FirstPayGateway::FirstPayPostData
- ActiveMerchant::Billing::GarantiGateway
- ActiveMerchant::Billing::Gateway
- ActiveMerchant::Billing::IdealBaseGateway
- ActiveMerchant::Billing::IdealRabobankGateway
- ActiveMerchant::Billing::IdealResponse
- ActiveMerchant::Billing::InspireGateway
- ActiveMerchant::Billing::InstapayGateway
- ActiveMerchant::Billing::Integrations
- ActiveMerchant::Billing::Integrations::ActionViewHelper
- ActiveMerchant::Billing::Integrations::Bogus
- ActiveMerchant::Billing::Integrations::Bogus::Helper
- ActiveMerchant::Billing::Integrations::Bogus::Notification
- ActiveMerchant::Billing::Integrations::Bogus::Return
- ActiveMerchant::Billing::Integrations::Chronopay
- ActiveMerchant::Billing::Integrations::Chronopay::Helper
- ActiveMerchant::Billing::Integrations::Chronopay::Return
- ActiveMerchant::Billing::Integrations::DirecPay
- ActiveMerchant::Billing::Integrations::DirecPay::Helper
- ActiveMerchant::Billing::Integrations::DirecPay::Notification
- ActiveMerchant::Billing::Integrations::DirecPay::Return
- ActiveMerchant::Billing::Integrations::DirecPay::Status
- ActiveMerchant::Billing::Integrations::Directebanking
- ActiveMerchant::Billing::Integrations::Directebanking::Helper
- ActiveMerchant::Billing::Integrations::Directebanking::Notification
- ActiveMerchant::Billing::Integrations::Directebanking::Return
- ActiveMerchant::Billing::Integrations::Dwolla
- ActiveMerchant::Billing::Integrations::Dwolla::Helper
- ActiveMerchant::Billing::Integrations::Dwolla::Notification
- ActiveMerchant::Billing::Integrations::Dwolla::Return
- ActiveMerchant::Billing::Integrations::EPaymentPlans
- ActiveMerchant::Billing::Integrations::EPaymentPlans::Helper
- ActiveMerchant::Billing::Integrations::EPaymentPlans::Notification
- ActiveMerchant::Billing::Integrations::Gestpay
- ActiveMerchant::Billing::Integrations::Gestpay::Common
- ActiveMerchant::Billing::Integrations::Gestpay::Helper
- ActiveMerchant::Billing::Integrations::Gestpay::Notification
- ActiveMerchant::Billing::Integrations::Gestpay::Return
- ActiveMerchant::Billing::Integrations::HiTrust
- ActiveMerchant::Billing::Integrations::HiTrust::Notification
- ActiveMerchant::Billing::Integrations::HiTrust::Return
- ActiveMerchant::Billing::Integrations::Moneybookers
- ActiveMerchant::Billing::Integrations::Moneybookers::Helper
- ActiveMerchant::Billing::Integrations::Nochex
- ActiveMerchant::Billing::Integrations::Nochex::Helper
- ActiveMerchant::Billing::Integrations::Nochex::Notification
- ActiveMerchant::Billing::Integrations::Nochex::Return
- ActiveMerchant::Billing::Integrations::Notification
- ActiveMerchant::Billing::Integrations::PayflowLink
- ActiveMerchant::Billing::Integrations::PayflowLink::Helper
- ActiveMerchant::Billing::Integrations::PayflowLink::Notification
- ActiveMerchant::Billing::Integrations::Paypal
- ActiveMerchant::Billing::Integrations::Paypal::Helper
- ActiveMerchant::Billing::Integrations::Paypal::Notification
- ActiveMerchant::Billing::Integrations::Paypal::Return
- ActiveMerchant::Billing::Integrations::Quickpay
- ActiveMerchant::Billing::Integrations::Quickpay::Helper
- ActiveMerchant::Billing::Integrations::Quickpay::Notification
- ActiveMerchant::Billing::Integrations::Return
- ActiveMerchant::Billing::Integrations::SagePayForm
- ActiveMerchant::Billing::Integrations::SagePayForm::Encryption
- ActiveMerchant::Billing::Integrations::SagePayForm::Helper
- ActiveMerchant::Billing::Integrations::SagePayForm::Notification
- ActiveMerchant::Billing::Integrations::SagePayForm::Notification::CryptError
- ActiveMerchant::Billing::Integrations::SagePayForm::Notification::InvalidCryptData
- ActiveMerchant::Billing::Integrations::SagePayForm::Notification::MissingCryptData
- ActiveMerchant::Billing::Integrations::SagePayForm::Notification::MissingCryptKey
- ActiveMerchant::Billing::Integrations::SagePayForm::Return
- ActiveMerchant::Billing::Integrations::TwoCheckout
- ActiveMerchant::Billing::Integrations::TwoCheckout::Helper
- ActiveMerchant::Billing::Integrations::TwoCheckout::Notification
- ActiveMerchant::Billing::Integrations::TwoCheckout::Return
- ActiveMerchant::Billing::Integrations::Valitor
- ActiveMerchant::Billing::Integrations::Valitor::Helper
- ActiveMerchant::Billing::Integrations::Valitor::Notification
- ActiveMerchant::Billing::Integrations::Valitor::ResponseFields
- ActiveMerchant::Billing::Integrations::Valitor::Return
- ActiveMerchant::Billing::Integrations::WorldPay
- ActiveMerchant::Billing::Integrations::WorldPay::Helper
- ActiveMerchant::Billing::Integrations::WorldPay::Notification
- ActiveMerchant::Billing::IridiumGateway
- ActiveMerchant::Billing::JetpayGateway
- ActiveMerchant::Billing::LinkpointGateway
- ActiveMerchant::Billing::MerchantESolutionsGateway
- ActiveMerchant::Billing::MerchantWareGateway
- ActiveMerchant::Billing::ModernPaymentsGateway
- ActiveMerchant::Billing::MonerisGateway
- ActiveMerchant::Billing::NetRegistryGateway
- ActiveMerchant::Billing::NetaxeptGateway
- ActiveMerchant::Billing::NetaxeptGateway::Response
- ActiveMerchant::Billing::NetbillingGateway
- ActiveMerchant::Billing::NmiGateway
- ActiveMerchant::Billing::OptimalPaymentGateway
- ActiveMerchant::Billing::OrbitalSoftDescriptors
- ActiveMerchant::Billing::PayJunctionGateway
- ActiveMerchant::Billing::PaySecureGateway
- ActiveMerchant::Billing::PayboxDirectGateway
- ActiveMerchant::Billing::PayflowCommonAPI
- ActiveMerchant::Billing::PayflowExpressResponse
- ActiveMerchant::Billing::PayflowExpressUkGateway
- ActiveMerchant::Billing::PayflowGateway
- ActiveMerchant::Billing::PayflowResponse
- ActiveMerchant::Billing::PayflowUkGateway
- ActiveMerchant::Billing::PaymentExpressGateway
- ActiveMerchant::Billing::PaymentExpressResponse
- ActiveMerchant::Billing::PaypalCaGateway
- ActiveMerchant::Billing::PaypalCommonAPI
- ActiveMerchant::Billing::PaypalExpressCommon
- ActiveMerchant::Billing::PaypalExpressGateway
- ActiveMerchant::Billing::PaypalExpressResponse
- ActiveMerchant::Billing::PaypalGateway
- ActiveMerchant::Billing::PlugnpayGateway
- ActiveMerchant::Billing::PlugnpayGateway::PlugnpayPostData
- ActiveMerchant::Billing::PsigateGateway
- ActiveMerchant::Billing::QbmsGateway
- ActiveMerchant::Billing::QuantumGateway
- ActiveMerchant::Billing::QuickpayGateway
- ActiveMerchant::Billing::RealexGateway
- ActiveMerchant::Billing::Response
- ActiveMerchant::Billing::SageGateway
- ActiveMerchant::Billing::SagePayGateway
- ActiveMerchant::Billing::SallieMaeGateway
- ActiveMerchant::Billing::SamuraiGateway
- ActiveMerchant::Billing::SecureNetGateway
- ActiveMerchant::Billing::SecurePayAuGateway
- ActiveMerchant::Billing::SecurePayGateway
- ActiveMerchant::Billing::SecurePayTechGateway
- ActiveMerchant::Billing::SecurePayTechGateway::SecurePayTechPostData
- ActiveMerchant::Billing::SkipJackGateway
- ActiveMerchant::Billing::StripeGateway
- ActiveMerchant::Billing::TransFirstGateway
- ActiveMerchant::Billing::TransaxGateway
- ActiveMerchant::Billing::TrustCommerceGateway
- ActiveMerchant::Billing::UsaEpayAdvancedGateway
- ActiveMerchant::Billing::UsaEpayGateway
- ActiveMerchant::Billing::UsaEpayTransactionGateway
- ActiveMerchant::Billing::VerifiGateway
- ActiveMerchant::Billing::VerifiGateway::VerifiPostData
- ActiveMerchant::Billing::ViaklixGateway
- ActiveMerchant::Billing::WirecardGateway
- ActiveMerchant::Billing::WorldpayGateway
- ActiveMerchant::Billing::WorldpayGateway::MultiResponse
- BraintreeCommon
- OutboundHosts

No matching classes.

# ActiveMerchant::Billing::Integrations::WorldPay::Notification

### Public Instance Methods

account() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 10
    def account
      params['instId']
    end

acknowledge() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 109
    def acknowledge
      return true
    end

address() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 54
    def address
      params['address']
    end

address_status() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 101
    def address_status
      return avs_value_to_symbol(params['AVS'][2].chr)
    end

card_type() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 78
    def card_type
      params['cardType']
    end

complete?() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 6
    def complete?
      status == 'Completed'
    end

country() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 62
    def country
      params['country']
    end

country_status() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 105
    def country_status
      return avs_value_to_symbol(params['AVS'][3].chr)
    end

currency() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 37
    def currency
      params['authCurrency']
    end

custom_params() click to toggle source

WorldPay supports the passing of custom parameters through to the callback script

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 114
    def custom_params
      return @custom_params ||= read_custom_params
    end

cvv_status() click to toggle source

WorldPay extended fraud checks returned as a 4 character string

    1st char: Credit card CVV check
    2nd char: Postcode AVS check
    3rd char: Address AVS check
    4th char: Country comparison check

Possible values are:

    :not_supported   -  0
    :not_checked     -  1
    :matched         -  2
    :not_matched     -  4
    :partial_match   -  8

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 93
    def cvv_status
      return avs_value_to_symbol(params['AVS'][0].chr)
    end

email_address() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 74
    def email_address
      params['email']
    end

fax_number() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 70
    def fax_number
      params['fax']
    end

gross() click to toggle source

the money amount we received in X.2 decimal.

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 33
    def gross
      params['authAmount']
    end

item_id() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 14
    def item_id
      params['cartId']
    end

name() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 50
    def name
      params['name']
    end

phone_number() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 66
    def phone_number
      params['tel']
    end

postcode() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 58
    def postcode
      params['postcode']
    end

postcode_status() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 97
    def postcode_status
      return avs_value_to_symbol(params['AVS'][1].chr)
    end

received_at() click to toggle source

Time this payment was received by the client in UTC time.

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 23
    def received_at
      Time.at(params['transTime'].to_i / 1000).utc
    end

security_key() click to toggle source

Callback password set in the WorldPay CMS

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 28
    def security_key
      params['callbackPW']
    end

status() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 46
    def status
      params['transStatus'] == 'Y' ? 'Completed' : 'Cancelled'
    end

test?() click to toggle source

Was this a test transaction?

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 42
    def test?
      params.key?('testMode') && params['testMode'] != '0'
    end

transaction_id() click to toggle source

    # File lib/active_merchant/billing/integrations/world_pay/notification.rb, line 18
    def transaction_id
      params['transId']
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.