Home > API Fields > Reply Fields


Reply Fields

 

Because CyberSource can add reply fields, reply codes, and reply flags at any time:

nYou must parse the reply data according to the names of the fields instead of the field order in the reply. For more information about parsing reply fields, see the documentation for your client.

nYour error handler should be able to process new reply codes and reply flags without problems.

nYour error handler should use the ics_rcode field to determine the result if it receives a reply flag that it does not recognize.

 

Your payment processor can include API reply fields that are not documented in this guide. See Credit Card Services Using the SCMP API for detailed descriptions of additional API reply fields.

Table 2Reply Fields

Field

Description

Returned By

Data Type & Length

auth_auth_amount

Amount that was authorized.

 

ics_auth

Decimal (15)

auth_auth_avs

AVS result code. See Credit Card Services Using the SCMP API for a detailed list of AVS values.

ics_auth

String (1)

auth_auth_code

Authorization code. Returned only when the processor returns this value.

 

ics_auth

String (7)

auth_auth_response

For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value.

ics_auth

String (10)

auth_auth_time

Time of authorization in UTC. See Data Type Definitions.

ics_auth

Date and time (20)

auth_avs_raw

AVS result code sent directly from the processor. Returned only when the processor returns this value.

 

ics_auth

String (10)

auth_rcode

Indicates whether the entire request was successful. Possible values:

n-1: An error occurred.

n0: The request was declined.

n1: The request was successful.

ics_auth

Integer (1)

auth_rflag

One-word description of the result of the entire request. See Credit Card Services Using the SCMP API for a detailed list of rflag values.

ics_auth

String (50)

auth_rmsg

Message that explains the reply flag auth_rflag. Do not display this message to the customer, and do not use this field to write an error handler.

ics_auth

String (255)

auth_trans_ref_no

Reference number for the transaction.

This value is not returned for all processors.

ics_auth

String (60)

currency

Currency used for the order. For the possible values, see the ISO Standard Currency Codes.

ics_auth

String (5)

ics_rcode

Indicates whether the service request was successful. Possible values:

n-1: An error occurred.

n0: The request was declined.

n1: The request was successful.

 

ics_auth

Integer (1)

ics_rflag

One-word description of the result of the entire request. See Credit Card Services Using the SCMP API for a detailed list of rflag values.

ics_auth

String (50)

ics_rmsg

Message that explains the reply flag ics_rflag. Do not display this message to the customer, and do not use this field to write an error handler.

 

ics_auth

String (255)

merchant_ref_number

Order reference or tracking number that you provided in the request. If you included multi-byte characters in this field in the request, the returned value might include corrupted characters.

ics_auth

String (50)

request_id

Identifier for the request.

 

ics_auth

String (26)

request_token

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 a maximum of 256 characters.

ics_auth

String (256)