NAME
Business::CyberSource::Response - Response Object
VERSION
version v0.4.1
DESCRIPTION
Every time you call submit on a request object it returns a response object. This response can be used to determine the success of a transaction, as well as receive a follow up request_id in case you need to do further actions with this. A response will always have decision, reason_code, reason_text, request_token, and request_id attributes. You should always use either introspection or check the decision to determine which attributes will be defined, as what is returned by CyberSource varies depending on what the decision is and what was sent in the request itself.
All of the responses contain the attributes here, however if the response is ACCEPT you will want to read the documentation for the Accept Role
ATTRIBUTES
reason_text
Reader: reason_text
Type: Str
This attribute is required.
Additional documentation: official description of returned reason code. warning: reason codes are returned by CyberSource and occasionally do not reflect the real reason for the error please inspect the trace request/response for issues
request_id
Reader: request_id
Type: MooseX::Types::Varchar::Varchar[29]
This attribute is required.
decision
Reader: decision
Type: MooseX::Types::CyberSource::Decision
This attribute is required.
Additional documentation: Summarizes the result of the overall request
reason_code
Reader: reason_code
Type: Int
This attribute is required.
Additional documentation: Numeric value corresponding to the result of the credit card authorization request
request_token
Reader: request_token
Type: MooseX::Types::Varchar::Varchar[256]
This attribute is required.
Additional documentation: Request token data created by CyberSource for each reply. The field is an encoded string that contains no confidential information, such as an account or card verification number. The string can contain up to 256 characters.
accepted
Reader: accepted
Type: Bool
Additional documentation: boolean way of determining whether the transaction was accepted
ATTRIBUTES
amount
Type: Num
Condition: ACCEPT
Amount that was approved.
currency
Type: MooseX::Types::Locale::Currency
Condition: ACCEPT
Currency code which was used to make the request
datetime
Type: MooseX::Types::DateTime::W3C::DateTimeW3C
Condition: ACCEPT
Request timestamp (will probably become a DateTime object at some point)
reference_code
Type: MooseX::Types::Varchar::Varchar[50]
Condition: ACCEPT
The merchant reference code originally sent
request_specific_reason_code
Type: Int
Condition: ACCEPT
Every successful request also has a reason code specific to its request type, e.g. for capture this is the ccCaptureReply_reasonCode.
processor_response
Type: MooseX::Types::Varchar::Varchar[10]
Condition: ACCEPT and be either an Authorization or Authorization Reversal
reconciliation_id
Type: Int
Condition: ACCEPT and be either a Credit or Capture
avs_code
Type: MooseX::Types::Varchar::Varchar[1]
Condition: ACCEPT and Authorization
avs_code_raw
Type: MooseX::Types::Varchar::Varchar[10]
Condition: ACCEPT and Authorization
auth_record
Type: Str
Condition: ACCEPT and Authorization
auth_code
Type: MooseX::Types::Varchar::Varchar[7]
Condition: ACCEPT and Authorization
cv_code
Type: MooseX::Types::Varchar::Varchar[1]
Condition: ACCEPT, Authorization, and cv_code actually returned
you can use predicate has_cv_code to check if attribute is defined
cv_code_raw
Type: MooseX::Types::Varchar::Varchar[10]
Condition: ACCEPT, Authorization, and cv_code_raw actually returned
you can use predicate has_cv_code to check if attribute is defined
BUGS
Please report any bugs or feature requests on the bugtracker website https://github.com/xenoterracide/Business-CyberSource/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
AUTHOR
Caleb Cushing <xenoterracide@gmail.com>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2011 by Caleb Cushing.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)