For more information about these data types, see the World Wide Web Consortium (W3C) XML Schema Part 2: DataTypes specification.
Integer—Whole number {..., -3, -2, -1, 0, 1, 2, 3, ...}.
String—Sequence of letters, numbers, spaces, and special characters, such as @ and #.
Note
You are responsible for storing the Boleto Bancário form URL. You might want to present the URL or its contents to the customer if you have to remind them that their payment is unexpectedly late and that the Boleto Bancário will time out soon. CyberSource does not store the URL.
Request Fields
The following table describes the fields to use in a request for the boletoPaymentService service.
Table 23 Request Fields for Boletos Bancários for the Simple Order API
Request Field Description Required or
Optional
Data Type
& Length
billTo_firstName Customer’s first name. Required String (60)
billTo_lastName Customer’s last name. Required String (60)
billTo_personalID Personal identifier. For CyberSource Latin American Processing, you can use this field for the Cadastro de Pessoas Fisicas (CPF).
Optional String (18)
boletoPaymentService_
expirationDate
Expiration date of the Boleto Bancário in GMT in ISO format: YYYY-MM-DD.
Optional String (10)
boletoPaymentService_
instruction
Text instructions for the Boleto Bancário.
This field allows you to specify the text that will be printed in the customer message field on the Boleto form. The customer message field is often used to remind the customer to submit the Boleto promptly.
Optional String (512)
boletoPaymentService_run Whether to include boletoPaymentService in your request. Possible values:
true: Include the service in your request.
false (default): Do not include the service in your request.
Required String (50)
item_#_unitPrice Per-item price of the product. You must include either this field or purchaseTotals_
grandTotalAmount in your request. For more information about items and grand totals, see Getting Started with
CyberSource Advanced for the Simple Order API.
This value cannot be negative. 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.
Optional Decimal
(15)
linkToRequest Value that links the current request to a previous authorization request for a debit card or prepaid card. This value is useful when using multiple payment methods to complete an order. For more information about partial authorizations, see Credit Card Services Using the Simple Order API.
Optional String (26)
Reply Fields
The following table describes the fields returned in a reply from boletoPaymentService.
merchantID Your CyberSource merchant ID.
Note When opening your account with CyberSource, be sure to inform CyberSource if you plan to use multiple CyberSource merchant IDs. For example, if you have separate business units within your company, each with a separate CyberSource merchant ID, you must have a separate processor merchant ID for each CyberSource merchant ID. For more information, contact Customer Support.
Required String (30)
merchantReferenceCode Merchant-generated order reference or tracking number. For more information, see Getting Started with CyberSource
Advanced for the Simple Order API.
Required String (50)
purchaseTotals_
grandTotalAmount
Grand total for the order. You must include either this field or item_#_unitPrice in your request. For more information, see Getting Started with CyberSource Advanced for the Simple Order API.
Required Decimal
(15) Table 23 Request Fields for Boletos Bancários for the Simple Order API (Continued)
Request Field Description Required or
Optional
Data Type
& Length
Table 24 Reply Fields for Boletos Bancários for the Simple Order API
Reply Field Description Data Type
& Length boletoPaymentReply_
amount
Total amount of the Boleto Bancário payment. Decimal (15) boletoPaymentReply_
boletoNumber
Boleto Bancário payment number. String (6)
boletoPaymentReply_
expirationDate
Expiration date of the Boleto Bancário in GMT. On the face of the Boleto Bancário, the date is in the European format: DD-MM-YYYY.
For this expiration date field, the date is mapped to an ISO format:
YYYY-MM-DD hh:mm:ss.
Note There is a space between the date and the time.
String (20)
boletoPaymentReply_
reasonCode
Numeric value corresponding to the result of the Boleto Bancário request. See Appendix B, "Reason Codes," on page 155.
Integer (5)
boletoPaymentReply_
reconciliationID
Unique value generated by CyberSource. For more information about tracking orders, see Getting Started with CyberSource Advanced for the Simple Order API.
String (60)
boletoPaymentReply_
requestDateTime
Time of the Boleto Bancário request in UTC.
Format: YYYY-MM-DDThh:mm:ssZ.
Example: 2007-08-11T22:47:57Z which is August 11, 2007 at 10:47:57 P.M.
The T separates the date and the time. The Z indicates UTC.
Date and time (20)
boletoPaymentReply_url URL of the Boleto Bancário form. String (255)
decision Summarizes the result of the overall request. Possible values:
ACCEPT
ERROR
REJECT
For more information about decision values, see Getting Started with CyberSource Advanced for the Simple Order API.
String (6)
invalidField_0…N Fields in the request that contained invalid data. These reply fields are included as an aid to software developers only. Do not attempt to use these fields for end user interaction. For more information about missing and invalid fields, see Getting Started with CyberSource Advanced for the Simple Order API.
String (100)
merchantReferenceCode 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. For more information about tracking orders, see Getting Started with CyberSource Advanced for the Simple Order API.
String (50)
missingField_0...N Required fields that were missing from the request. These reply fields are included as an aid to software developers only. Do not attempt to use these fields for end user interaction. For more information about missing and invalid fields, see Getting Started with CyberSource Advanced for the Simple Order API.
String (100)
purchaseTotals_currency Currency used for the order. The only possible value is BRL. String (5) reasonCode Numeric value corresponding to the result of the overall request.
See Appendix B, "Reason Codes," on page 155.
Integer (5)
requestID Identifier for the request. For more information about request tokens, see Getting Started with CyberSource Advanced for the Simple Order API.
String (26) Table 24 Reply Fields for Boletos Bancários for the Simple Order API (Continued)
Reply Field Description Data Type
& Length