Skip to main content

Product Role: Batch

The Batch product role grants access to submit and process bulk payment files through Connected Payments' SFTP server and batch API.

What You Can Do

Submit Batch Files

  • Upload CSV files via SFTP
  • Process multiple transactions
  • Scheduled processing
  • Automated reconciliation

Permissions

PermissionDescription
Submit batch filesUpload CSV files via SFTP for bulk processing
Process token paymentsProcess bulk payments using stored tokens
Query batch statusCheck processing status and retrieve results via API
Retrieve masked PANQuery token details for validation
Download reportsAccess batch processing results and reports

Available Services

Batch Submission

Submit bulk payment files via SFTP for automated processing.

What You Can Process:

  • Purchases
  • Refunds
  • Captures
  • Token-based payments

How It Works:

  1. Prepare CSV file with transaction data
  2. Connect to SFTP server with credentials
  3. Upload file to designated directory
  4. File automatically detected and processed
  5. Results available via API or email

For detailed file format, SFTP configuration, and examples, see:

Token Payments

Process bulk payments using previously stored card tokens.

Benefits:

  • No need to re-enter card details
  • Faster processing
  • Lower decline rates
  • Ideal for recurring billing

For token creation and management, see:

Batch API

Query batch status and retrieve processing results programmatically.

Query Batch Status

Check the processing status of submitted batch files.

Returns:

  • Batch ID
  • Processing status
  • Total records
  • Successful records
  • Failed records
  • Error details

For API endpoints, request/response formats, and code examples, see:

Retrieve Token Details

Query non-sensitive token information (masked PAN) for validation.

What You Can Retrieve:

  • Masked card number
  • Card type and expiry
  • Cardholder name
  • Token metadata

For API endpoints and detailed information, see:

Authentication

SFTP Access

Batch users receive SFTP credentials to upload batch files.

For batch credentials or SFTP access:

API Access

Batch users authenticate API requests using their username and password.