The following table lists the offer-level fields to use in a request for ics_bank_transfer or ics_bank_transfer_refund.
Table 8 Offer-Level Fields for Bank Transfers and Bank Transfer Refunds for the SCMP API
Offer-Level Field Description Used by and
Required (R) or Optional (O)
Data Type
& Length
amount Per-item price of the product. You must include either offer0 and this field, or the request-level field grand_total_amount in your request. This value cannot be negative. See the information about offers and grand totals in Getting Started with CyberSource Advanced for the SCMP API.
You can include a decimal point (.) in this field, but you cannot include any other special characters.
The amount will be truncated at the request level to the correct number of decimal places.
Bank Transfer (See description)
Product identifier code. It is required for bank transfers if product_code is not default, stored_value, or one of the values related to shipping and/or handling.
Bank Transfer (See description) Refund (O)
String (30)
product_code Type of product that the offer contains, which is also used to determine the category that the product falls under: electronic, handling, physical, service, or shipping. The default value is
default. See "Product Codes," page 154, for a list of valid values.
For bank transfers, if you set this to a value other than default, stored_value, or any of the values related to shipping and/or handling, the quantity, product_name, and merchant_
product_sku fields are required.
Bank Transfer (O) Refund (O)
String (30)
product_name Name of the product. For bank transfers, required if product_code is NOT default, stored_
value, or one of the values related to shipping and/or handling.
Bank Transfer (See description) Refund (O)
String (30)
quantity Quantity of the product being purchased. The default value is 1. For bank transfers, required if product_code is NOT default, stored_
value or one of the values related to shipping and/or handling.
Bank Transfer (See description) Refund (O)
Non-negative integer (10)
Reply Fields
The following table lists the fields returned in a reply from ics_bank_transfer or ics_
bank_transfer_refund.
tax_amount Tax amount associated with this item. The tax_
amount field is additive. For example, if you send these offer lines:
offer0=amount:10.00^
quantity:1^tax_amount:0.80 offer1=amount:20.00^
quantity:1^tax_amount:1.60 the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included.
The tax_amount and the amount must be in the same currency.
If you include tax_amount, and you request the ics_tax service, ics_tax will not calculate tax for the offer. Instead, it will return the value in the tax_
amount field.
Bank Transfer (O) Refund (O)
Decimal (15) Table 8 Offer-Level Fields for Bank Transfers and Bank Transfer Refunds
for the SCMP API (Continued)
Offer-Level Field Description Used by and
Required (R) or Optional (O)
Data Type
& Length
Table 9 Reply Fields for Bank Transfers and Bank Transfer Refunds for the SCMP API
Reply Field Description Returned
By
Data Type
& Length bank_transfer_account_
holder
Name of the account holder. Bank Transfer String (50)
bank_transfer_account_
number
Bank account number. Use the contents of this field along with the contents of the bank_transfer_
special_id field to display on the bank transfer confirmation page the country’s traditional representation of the full bank account number.
Contact CyberSource Customer Support for required country-specific bank account information.
Bank Transfer String (30)
bank_transfer_amount Total amount for the bank transfer. Bank Transfer Decimal (15) bank_transfer_bank_city City in which the bank is located. Bank Transfer String (50) bank_transfer_bank_
country
Country in which the bank is located. Bank Transfer String (50)
bank_transfer_bank_
name
Bank’s name. Bank Transfer String (50)
bank_transfer_iban International Bank Account Number (IBAN) for the bank account. If this field is in the reply, display the value to the customer along with the other bank information.
Note Contact CyberSource Customer Support for required country-specific bank account information.
Bank Transfer String (30)
bank_transfer_
payment_reference
Payment reference number that you must display to the customer. For more information, see Getting Started with CyberSource Advanced for the SCMP API. In Italy, this is called the Numero di riferimento.
Bank Transfer String (16)
bank_transfer_rcode One-digit code that indicates whether the ics_
bank_transfer request was successful.
Bank Transfer Integer (1)
bank_transfer_refund_
amount
Amount of the bank transfer refund. Refund Decimal (15)
bank_transfer_refund__
iban
International Bank Account Number (IBAN) for the bank account.
Refund Alphanumeric (50)
bank_transfer_refund_
rcode
One-digit code that indicates whether the ics_
bank_transfer_refund request was successful.
Refund Integer (1)
bank_transfer_refund_
response_code
Response code from the processor. Refund String (10)
bank_transfer_refund_
rflag
One-word description of the result of the ics_bank_
transfer_refund request.
Refund String (50)
bank_transfer_refund_
rmsg
Message that explains the reply flag bank_
transfer_refund_rflag.
Refund String (255)
bank_transfer_refund_
time
Time of bank transfer refund request in UTC format.
For more information, see Getting Started with CyberSource Advanced for the SCMP API.
Refund Date and
time (20)
bank_transfer_refund_
trans_ref_no
Unique value generated by CyberSource. See the information about tracking orders in Getting Started with CyberSource Advanced for the SCMP API.
Refund String (60)
bank_transfer_request_
time
Time of the bank transfer request in UTC format. For more information, see Getting Started with
CyberSource Advanced for the SCMP API.
Bank Transfer Date and time (20)
bank_transfer_
response_code
Response code from the processor. Bank Transfer String (10)
bank_transfer_rflag One-word description of the result of the ics_bank_
transfer request.
Bank Transfer String (50)
bank_transfer_rmsg Message that explains the reply flag bank_
transfer_rflag.
Bank Transfer String (255) Table 9 Reply Fields for Bank Transfers and Bank Transfer Refunds
for the SCMP API (Continued)
Reply Field Description Returned
By
Data Type
& Length
bank_transfer_special_
id
Contains any special ID used for the bank. For example, the sort code for U.K. banks. This field is only for the Global Collect processor. Use the contents of this field along with the contents of the bank_transfer_account_number field to display on the bank transfer confirmation page the country’s traditional representation of the full bank account number. Contact CyberSource Customer Support for required country-specific bank account information.
Bank Transfer String (50)
bank_transfer_swiftcode Bank’s SWIFT code. Unique address of the bank. If this field is in the reply, display the value to the customer along with the other bank information.
Bank Transfer String (50)
bank_transfer_trans_
ref_no
Unique value generated by CyberSource. For more information, see Getting Started with CyberSource Advanced for the SCMP API.
Bank Transfer String (60)
client_lib_version Information about the client library used to request the transaction.
Bank Transfer and Refund
String (50)
currency Currency used for the order. Uses the ISO Standard Currency Codes.
Bank Transfer and Refund
String (5)
ics_rcode One-digit code that indicates whether the entire request was successful. The field will contain one of the following values:
-1: An error occurred
0: The request was declined
1: The request was successful
Bank Transfer and Refund
Integer (1)
ics_rflag One-word description of the result of the entire request.
Bank Transfer and Refund
String (50)
ics_rmsg Message that explains the reply flag ics_rflag. Bank Transfer and Refund
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 contain corrupted characters.
Bank Transfer and Refund
String (50)
request_id Identifier for the request generated by CyberSource. Bank Transfer and Refund
String (26) Table 9 Reply Fields for Bank Transfers and Bank Transfer Refunds
for the SCMP API (Continued)
Reply Field Description Returned
By
Data Type
& Length