API Overview

Offline Transaction File Submission Implementation Guide
- Recent Revisions to This Document

Introduction to Offline Transaction File Submission
- Payment Services Supported
- Requirements for Uploading Batch Files
- Batch Files and Batch File Templates
- Validation and Processing Results
- Flow of Batch File Submission and Transaction Processing

Managing Templates and Batch Files
- Batch File Templates
- Available Batch File Templates
- Download a Batch File Template
- Create a Custom Batch File Template
- Create a Batch File
- Example Batch Files
  - Example Batch File for an Authorization Request
  - Example Batch File for a Sale Request
  - Example Batch File for a Capture Request
  - Example Batch File for a Credit Request
  - Example Batch File for a Void Request

Cybersource Business Center: Uploading a Batch File
- Upload a Batch File at the Business Center
- Batch Processing Status

REST API: Setting Up an API Endpoint Connection
- Mutual TLS Authentication
- Mutual TLS Two-Way Handshake
- Requirements for Setting Up a REST API Endpoint Connection
- Generate and Install a Private Key and Client Certificate on a Client Machine
- Exchange the Client and Server Public Certificates
- Install and Use a Server Certificate on a Client Machine

REST API: Encrypting and Uploading a Batch File
- Requirements for Encrypting and Uploading a Batch File Using the REST API
- Download Java Sample Code and Create Your Java App
- Encrypt and Upload the Batch File
- Check the Validation and Processing Results

Viewing Email Notifications
- Email Notification for a Failed Batch Validation
- Email Notification for a Successful Batch Validation
- Email Notification for Successful Transaction Processing

Viewing the Results of Batch File Validation
- Download a Batch Validation Response File
- Batch Validation Response File DTD
- Batch Validation Response File XML Elements
  - The Batch Element
  - The ValidationErrors Element
  - The Error Element
- Batch Validation Error Codes
- Example: Successful Batch Validation
- Example: Incorrect Record Count in the Trailer
- Example: Field Count in Some Data Records Does Not Match the Header
- Example: Field Count in More Than 10 Data Records Does Not Match the Header

Viewing the Results of Transaction Processing
- Download a Transaction Response File
- Fields in the Header Record
- Fields in Each Data Record
- Example Transaction Response File

Viewing the Transaction Request Report
- Download a Transaction Request Report
- Transaction Request Report DTD
- Transaction Request Report XML Elements
  - The Report Element
  - The BatchFiles Element
  - The BatchFile Element
  - The PaymentProcessor Element
  - The Request Element
- Example XML-Formatted Transaction Request Report
- Transaction Request Report CSV Records
  - First Header Record
  - Second Header Record
  - Transaction Record
- Example CSV-Formatted Transaction Request Report

Viewing the Batch Submission Detail Report
- Download a Batch Submission Detail Report
- Batch Submission Detail Report DTD
- Example XML-Formatted Batch Submission Detail Report
- Example CSV-Formatted Batch Submission Detail Report

Reference: Request Fields for Batch Files
- Fields for an Authorization Request
- Fields for a Sale Request
- Fields for a Capture Request
- Fields for a Credit Request
- Fields for an ACH Service Debit Request
- Fields for an ACH Service Credit Request

Reference: Mapping SCMP API Field Names to Simple Order Names
- Request-Level Fields
- Core Response Fields
- Offer-Level Fields
- Response Fields

On This Page

Recent Revisions to This Document

26.03.01

Initial release.

Back to top